Deploy

Author: DX-Bandwidth

bandwidth/controllers/base_controller.py

@@ -27,7 +27,7 @@ class BaseController(object):
     """
 
     global_headers = {
-        'user-agent': 'python-sdk-refs/tags/python6.5.0'
+        'user-agent': 'python-sdk-refs/tags/python6.6.0'
     }
 
     def __init__(self, config, call_back=None):

bandwidth/messaging/controllers/base_controller.py

@@ -27,7 +27,7 @@ class BaseController(object):
     """
 
     global_headers = {
-        'user-agent': 'python-sdk-refs/tags/python6.5.0'
+        'user-agent': 'python-sdk-refs/tags/python6.6.0'
     }
 
     def __init__(self, config, call_back=None):

bandwidth/twofactorauth/__init__.py

@@ -1,5 +1,6 @@
 __all__ = [
     'controllers',
+    'exceptions',
     'models',
     'two_factor_auth_client',
 ]

bandwidth/twofactorauth/controllers/api_controller.py

@@ -14,6 +14,7 @@
 from bandwidth.twofactorauth.models.two_factor_voice_response import TwoFactorVoiceResponse
 from bandwidth.twofactorauth.models.two_factor_messaging_response import TwoFactorMessagingResponse
 from bandwidth.twofactorauth.models.two_factor_verify_code_response import TwoFactorVerifyCodeResponse
+from bandwidth.twofactorauth.exceptions.invalid_request_exception import InvalidRequestException
 
 
 class APIController(BaseController):
@@ -67,6 +68,10 @@ def create_voice_two_factor(self,
         _request = self.config.http_client.post(_query_url, headers=_headers, parameters=APIHelper.json_serialize(body))
         TwoFactorAuthBasicAuth.apply(self.config, _request)
         _response = self.execute_request(_request)
+
+        # Endpoint and global error handling using HTTP status codes.
+        if _response.status_code == 400:
+            raise InvalidRequestException('client request error', _response)
         self.validate_response(_response)
 
         decoded = APIHelper.json_deserialize(_response.text, TwoFactorVoiceResponse.from_dictionary)
@@ -117,6 +122,10 @@ def create_messaging_two_factor(self,
         _request = self.config.http_client.post(_query_url, headers=_headers, parameters=APIHelper.json_serialize(body))
         TwoFactorAuthBasicAuth.apply(self.config, _request)
         _response = self.execute_request(_request)
+
+        # Endpoint and global error handling using HTTP status codes.
+        if _response.status_code == 400:
+            raise InvalidRequestException('client request error', _response)
         self.validate_response(_response)
 
         decoded = APIHelper.json_deserialize(_response.text, TwoFactorMessagingResponse.from_dictionary)
@@ -166,6 +175,10 @@ def create_verify_two_factor(self,
         _request = self.config.http_client.post(_query_url, headers=_headers, parameters=APIHelper.json_serialize(body))
         TwoFactorAuthBasicAuth.apply(self.config, _request)
         _response = self.execute_request(_request)
+
+        # Endpoint and global error handling using HTTP status codes.
+        if _response.status_code == 400:
+            raise InvalidRequestException('client request error', _response)
         self.validate_response(_response)
 
         decoded = APIHelper.json_deserialize(_response.text, TwoFactorVerifyCodeResponse.from_dictionary)

bandwidth/twofactorauth/controllers/base_controller.py

@@ -27,7 +27,7 @@ class BaseController(object):
     """
 
     global_headers = {
-        'user-agent': 'python-sdk-refs/tags/python6.5.0'
+        'user-agent': 'python-sdk-refs/tags/python6.6.0'
     }
 
     def __init__(self, config, call_back=None):

bandwidth/twofactorauth/exceptions/__init__.py

@@ -0,0 +1,3 @@
+__all__ = [
+    'invalid_request_exception',
+]

bandwidth/twofactorauth/exceptions/invalid_request_exception.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+
+"""
+bandwidth
+
+This file was automatically generated by APIMATIC v2.0 ( https://apimatic.io ).
+"""
+
+from bandwidth.api_helper import APIHelper
+import bandwidth.exceptions.api_exception
+
+
+class InvalidRequestException(bandwidth.exceptions.api_exception.APIException):
+    def __init__(self, reason, response):
+        """Constructor for the InvalidRequestException class
+
+        Args:
+            reason (string): The reason (or error message) for the Exception
+                to be raised.
+            response (HttpResponse): The HttpResponse of the API call.
+
+        """
+        super(InvalidRequestException, self).__init__(reason, response)
+        dictionary = APIHelper.json_deserialize(self.response.text)
+        if isinstance(dictionary, dict):
+            self.unbox(dictionary)
+
+    def unbox(self, dictionary):
+        """Populates the properties of this object by extracting them from a dictionary.
+
+        Args:
+            dictionary (dictionary): A dictionary representation of the object as
+            obtained from the deserialization of the server's response. The keys
+            MUST match property names in the API description.
+
+        """
+        self.result = dictionary.get('result')

bandwidth/twofactorauth/models/two_factor_code_request_schema.py

@@ -14,10 +14,23 @@ class TwoFactorCodeRequestSchema(object):
     TODO: type model description here.
 
     Attributes:
-        to (string): TODO: type description here.
-        mfrom (string): TODO: type description here.
-        application_id (string): TODO: type description here.
-        scope (string): TODO: type description here.
+        to (string): The phone number to send the 2fa code to.
+        mfrom (string): The application phone number, the sender of the 2fa
+            code.
+        application_id (string): The application unique ID, obtained from
+            Bandwidth.
+        scope (string): An optional field to denote what scope or action the
+            2fa code is addressing.  If not supplied, defaults to "2FA".
+        message (string): The message format of the 2fa code.  There are three
+            values that the system will replace "{CODE}", "{NAME}", "{SCOPE}".
+            The "{SCOPE}" and "{NAME} value template are optional, while
+            "{CODE}" must be supplied.  As the name would suggest, code will
+            be replace with the actual 2fa code.  Name is replaced with the
+            application name, configured during provisioning of 2fa.  The
+            scope value is the same value sent during the call and partitioned
+            by the server.
+        digits (float): The number of digits for your 2fa code.  The valid
+            number ranges from 2 to 8, inclusively.
 
     """
 
@@ -26,13 +39,17 @@ class TwoFactorCodeRequestSchema(object):
         "to": 'to',
         "mfrom": 'from',
         "application_id": 'applicationId',
+        "message": 'message',
+        "digits": 'digits',
         "scope": 'scope'
     }
 
     def __init__(self,
                  to=None,
                  mfrom=None,
                  application_id=None,
+                 message=None,
+                 digits=None,
                  scope=None):
         """Constructor for the TwoFactorCodeRequestSchema class"""
 
@@ -41,6 +58,8 @@ def __init__(self,
         self.mfrom = mfrom
         self.application_id = application_id
         self.scope = scope
+        self.message = message
+        self.digits = digits
 
     @classmethod
     def from_dictionary(cls,
@@ -63,10 +82,14 @@ def from_dictionary(cls,
         to = dictionary.get('to')
         mfrom = dictionary.get('from')
         application_id = dictionary.get('applicationId')
+        message = dictionary.get('message')
+        digits = dictionary.get('digits')
         scope = dictionary.get('scope')
 
         # Return an object of this model
         return cls(to,
                    mfrom,
                    application_id,
+                   message,
+                   digits,
                    scope)

bandwidth/twofactorauth/models/two_factor_verify_request_schema.py

@@ -14,11 +14,21 @@ class TwoFactorVerifyRequestSchema(object):
     TODO: type model description here.
 
     Attributes:
-        to (string): TODO: type description here.
-        mfrom (string): TODO: type description here.
-        application_id (string): TODO: type description here.
-        scope (string): TODO: type description here.
-        code (string): TODO: type description here.
+        to (string): The phone number to send the 2fa code to.
+        mfrom (string): The application phone number, the sender of the 2fa
+            code.
+        application_id (string): The application unique ID, obtained from
+            Bandwidth.
+        scope (string): An optional field to denote what scope or action the
+            2fa code is addressing.  If not supplied, defaults to "2FA".
+        digits (float): The number of digits for your 2fa code.  The valid
+            number ranges from 2 to 8, inclusively.
+        expiration_time_in_minutes (float): The time period, in minutes, to
+            validate the 2fa code.  By setting this to 3 minutes, it will mean
+            any code generated within the last 3 minutes are still valid.  The
+            valid range for expiration time is between 0 and 15 minutes,
+            exclusively and inclusively, respectively.
+        code (string): The generated 2fa code to check if valid
 
     """
 
@@ -27,23 +37,29 @@ class TwoFactorVerifyRequestSchema(object):
         "to": 'to',
         "mfrom": 'from',
         "application_id": 'applicationId',
-        "scope": 'scope',
-        "code": 'code'
+        "digits": 'digits',
+        "expiration_time_in_minutes": 'expirationTimeInMinutes',
+        "code": 'code',
+        "scope": 'scope'
     }
 
     def __init__(self,
                  to=None,
                  mfrom=None,
                  application_id=None,
-                 scope=None,
-                 code=None):
+                 digits=None,
+                 expiration_time_in_minutes=None,
+                 code=None,
+                 scope=None):
         """Constructor for the TwoFactorVerifyRequestSchema class"""
 
         # Initialize members of the class
         self.to = to
         self.mfrom = mfrom
         self.application_id = application_id
         self.scope = scope
+        self.digits = digits
+        self.expiration_time_in_minutes = expiration_time_in_minutes
         self.code = code
 
     @classmethod
@@ -67,12 +83,16 @@ def from_dictionary(cls,
         to = dictionary.get('to')
         mfrom = dictionary.get('from')
         application_id = dictionary.get('applicationId')
-        scope = dictionary.get('scope')
+        digits = dictionary.get('digits')
+        expiration_time_in_minutes = dictionary.get('expirationTimeInMinutes')
         code = dictionary.get('code')
+        scope = dictionary.get('scope')
 
         # Return an object of this model
         return cls(to,
                    mfrom,
                    application_id,
-                   scope,
-                   code)
+                   digits,
+                   expiration_time_in_minutes,
+                   code,
+                   scope)

bandwidth/voice/controllers/base_controller.py

@@ -27,7 +27,7 @@ class BaseController(object):
     """
 
     global_headers = {
-        'user-agent': 'python-sdk-refs/tags/python6.5.0'
+        'user-agent': 'python-sdk-refs/tags/python6.6.0'
     }
 
     def __init__(self, config, call_back=None):