Added Hook entity type to allow management of URL notifications;

Modified BankAccount handling and added five new types of bank accounts (IBAN, GB, US, CA and OTHER);
Minor changes related to code cleanup.

Author: lukasz-drzewiecki

mangopay2-python-sdk.pyproj

@@ -28,10 +28,10 @@
     <Compile Include="mangopaysdk\entities\bankaccount.py">
       <SubType>Code</SubType>
     </Compile>
-    <Compile Include="mangopaysdk\entities\aaaabankwire.py" />
     <Compile Include="mangopaysdk\entities\card.py" />
     <Compile Include="mangopaysdk\entities\cardpreauthorization.py" />
     <Compile Include="mangopaysdk\entities\cardregistration.py" />
+    <Compile Include="mangopaysdk\entities\hook.py" />
     <Compile Include="mangopaysdk\entities\kycpage.py" />
     <Compile Include="mangopaysdk\entities\kycdocument.py" />
     <Compile Include="mangopaysdk\entities\event.py" />
@@ -45,6 +45,7 @@
     <Compile Include="mangopaysdk\tools\apicards.py" />
     <Compile Include="mangopaysdk\tools\apicardregistrations.py" />
     <Compile Include="mangopaysdk\tools\apievents.py" />
+    <Compile Include="mangopaysdk\tools\apihooks.py" />
     <Compile Include="mangopaysdk\tools\storages\authorizationtokenmanager.py">
       <SubType>Code</SubType>
     </Compile>
@@ -58,6 +59,12 @@
     <Compile Include="mangopaysdk\tools\storages\__init__.py">
       <SubType>Code</SubType>
     </Compile>
+    <Compile Include="mangopaysdk\types\bankaccountdetails.py" />
+    <Compile Include="mangopaysdk\types\bankaccountdetailsca.py" />
+    <Compile Include="mangopaysdk\types\bankaccountdetailsgb.py" />
+    <Compile Include="mangopaysdk\types\bankaccountdetailsiban.py" />
+    <Compile Include="mangopaysdk\types\bankaccountdetailsother.py" />
+    <Compile Include="mangopaysdk\types\bankaccountdetailsus.py" />
     <Compile Include="mangopaysdk\types\payinexecutiondetailsdirect.py" />
     <Compile Include="mangopaysdk\types\payinpaymentdetailsdirectcard.py" />
     <Compile Include="mangopaysdk\entities\refund.py" />
@@ -176,6 +183,7 @@
     <Compile Include="setup.py" />
     <Compile Include="tests\testcardpreauthorizations.py" />
     <Compile Include="tests\testevents.py" />
+    <Compile Include="tests\testhooks.py" />
     <Compile Include="tests\testrefunds.py">
       <SubType>Code</SubType>
     </Compile>

mangopaysdk/entities/bankaccount.py

@@ -7,16 +7,30 @@ class BankAccount(EntityBase):
     def __init__(self, id = None):
         self.UserId = None
         # Type of bank account
-        self.Type = 'IBAN'
+        self.Type = None
         self.OwnerName = None
         self.OwnerAddress = None
         # must be valid ^[a-zA-Z]{2}\d{2}\s*(\w{4}\s*){2,7}\w{1,4}
-        self.IBAN = None
+        #self.IBAN = None
+        self.Details = None
         # example BREXPLPWKRA
-        self.BIC = None
+        #self.BIC = None
         return super(BankAccount, self).__init__(id)
 
     def GetReadOnlyProperties(self):
         properties = super(BankAccount, self).GetReadOnlyProperties()
-        properties.append('UserId' )        
-        return properties
+        properties.append('UserId')
+        properties.append('Type')
+        return properties
+
+    def GetDependsObjects(self):
+        return { 
+                'Type': {
+                    '_property_name': 'Details', 
+                    'IBAN': 'BankAccountDetailsIBAN',
+                    'GB': 'BankAccountDetailsGB',
+                    'US': 'BankAccountDetailsUS',
+                    'CA': 'BankAccountDetailsCA',
+                    'OTHER': 'BankAccountDetailsOTHER'
+                }
+        }

mangopaysdk/entities/hook.py

@@ -0,0 +1,11 @@
+from mangopaysdk.entities.entitybase import EntityBase
+
+class Hook(EntityBase):
+    """Hooks and Notifications entity."""
+
+    def __init__(self, id = None):
+        self.Url = None
+        self.Status = None
+        self.Validity = None
+        self.EventType = None
+        return super(Hook, self).__init__(id)

mangopaysdk/mangopayapi.py

@@ -1,5 +1,5 @@
 from mangopaysdk.tools import apioauth, apiclients, apiusers, apiwallets, apitransfers, apipayins, apipayouts, apievents, apicardpreauthorizations
-from mangopaysdk.tools import apirefunds, apicardregistrations, apicards
+from mangopaysdk.tools import apirefunds, apicardregistrations, apicards, apihooks
 from mangopaysdk.configuration import Configuration
 from mangopaysdk.tools.storages.authorizationtokenmanager import AuthorizationTokenManager
 
@@ -36,4 +36,5 @@ def __init__(self):
         self.cardRegistrations = apicardregistrations.ApiCardRegistrations(self)
         self.cardPreAuthorizations = apicardpreauthorizations.ApiCardPreAuthorizations(self)        
         self.cards = apicards.ApiCards(self)
-        self.events = apievents.ApiEvents(self)
+        self.events = apievents.ApiEvents(self)
+        self.hooks = apihooks.ApiHooks(self)

mangopaysdk/tools/apibase.py

@@ -3,6 +3,7 @@
 from mangopaysdk.types.dto import Dto 
 from mangopaysdk.types.money import Money
 import json, inspect
+from mangopaysdk.tools.resttool import RestTool
 from mangopaysdk.entities.event import Event
 from mangopaysdk.entities.kycdocument import KycDocument
 from mangopaysdk.entities.kycpage import KycPage
@@ -20,6 +21,7 @@
 from mangopaysdk.entities.refund import Refund
 from mangopaysdk.entities.cardregistration import CardRegistration
 from mangopaysdk.entities.cardpreauthorization import CardPreAuthorization
+from mangopaysdk.entities.hook import Hook
 from mangopaysdk.types.payinexecutiondetails import PayInExecutionDetails
 from mangopaysdk.types.payinexecutiondetailsweb import PayInExecutionDetailsWeb
 from mangopaysdk.types.payinpaymentdetails import PayInPaymentDetails
@@ -29,7 +31,11 @@
 from mangopaysdk.types.payoutpaymentdetails import PayOutPaymentDetails
 from mangopaysdk.types.payinexecutiondetailsdirect import PayInExecutionDetailsDirect
 from mangopaysdk.types.payoutpaymentdetailsbankwire import PayOutPaymentDetailsBankWire
-from mangopaysdk.tools.resttool import RestTool
+from mangopaysdk.types.bankaccountdetailsiban import BankAccountDetailsIBAN
+from mangopaysdk.types.bankaccountdetailsgb import BankAccountDetailsGB
+from mangopaysdk.types.bankaccountdetailsus import BankAccountDetailsUS
+from mangopaysdk.types.bankaccountdetailsca import BankAccountDetailsCA
+from mangopaysdk.types.bankaccountdetailsother import BankAccountDetailsOTHER
 
 
 class ApiBase(object):
@@ -124,7 +130,12 @@ class ApiBase(object):
         'users_getkycdocument' : ('/users/%s/KYC/documents/%s', 'GET'),
         'users_savekycdocument' : ('/users/%s/KYC/documents/%s', 'PUT'),
 
-        'users_createbankaccounts' : ('/users/%s/bankaccounts', 'POST'),
+        'users_createbankaccounts_iban': ('/users/%s/bankaccounts/iban', 'POST'),
+        'users_createbankaccounts_gb': ('/users/%s/bankaccounts/gb', 'POST'),
+        'users_createbankaccounts_us': ('/users/%s/bankaccounts/us', 'POST'),
+        'users_createbankaccounts_ca': ('/users/%s/bankaccounts/ca', 'POST'),
+        'users_createbankaccounts_other': ('/users/%s/bankaccounts/other', 'POST'),
+
         'users_all' : ('/users', 'GET'),
         'users_allkyc' : ('/users/%s/KYC', 'GET'),
         'users_allkycrequests' : ('/users/%s/KYC/requests', 'GET'),
@@ -355,4 +366,6 @@ def _canReadSubRequestData (self, entity, propertyName):
             return True
         if isinstance(entity, PayOut) and propertyName == 'MeanOfPaymentDetails':
             return True
+        if isinstance(entity, BankAccount) and propertyName == 'Details':
+            return True
         return False

mangopaysdk/tools/apihooks.py

@@ -0,0 +1,31 @@
+from mangopaysdk.tools.apibase import ApiBase
+
+class ApiHooks(ApiBase):
+    """MangoPay API for hooks and notifications."""
+
+    def Create(self, hook):
+        """Creates a new hook.
+        param Hook hook
+        return Newly created hook object returned from API
+        """
+        return self._createObject('hooks_create', hook, 'Hook')
+    
+    def Get(self, hookId):
+        """Gets hook.
+        param type hookId Hook identifier
+        return Hook object returned from API
+        """
+        return self._getObject('hooks_get', hookId, 'Hook')
+    
+    def Update(self, hook):
+        """Updates a hook.
+        param Hook hook Hook object to update
+        return Updated hook object returned from API
+        """
+        return self._saveObject('hooks_save', hook, 'Hook')
+    
+    def GetAll(self, pagination = None):
+        """Gets all hooks.
+        return Array of objects returned from API
+        """
+        return self._getList('hooks_all', pagination, 'Hook')

mangopaysdk/tools/apiusers.py

@@ -5,6 +5,8 @@
 from mangopaysdk.entities.bankaccount import BankAccount
 from mangopaysdk.entities.kycdocument import KycDocument
 from mangopaysdk.entities.kycpage import KycPage
+import collections
+import os.path
 
 
 class ApiUsers(ApiBase):
@@ -78,7 +80,8 @@ def CreateBankAccount(self, userId, bankAccount):
         param BankAccount Entity of bank account with fields: OwnerName, UserId, Type, OwnerAddress,IBAN, BIC, Tag
         return BankAccount Create bank account object
         """
-        return self._createObject('users_createbankaccounts', bankAccount, 'BankAccount', userId)
+        type = self.GetBankAccountType(bankAccount)
+        return self._createObject('users_createbankaccounts_' + type, bankAccount, 'BankAccount', userId)
 
     def GetBankAccounts(self, userId, pagination = None):
         """Get all bank accounts for user.
@@ -149,7 +152,7 @@ def CreateUserKycPage(self, kycPage, userId, kycDocumentId):
         param Int/GUID User identifier
         param Int/GUID KycDocument identifier
         """
-        self._createObject('users_createkycpage', kycPage, None, userId, kycDocumentId)
+        return self._createObject('users_createkycpage', kycPage, None, userId, kycDocumentId)
 
     def UpdateUserKycDocument(self, kycDocument, userId, kycDocumentId):
         """Updates KycDocument     
@@ -158,4 +161,40 @@ def UpdateUserKycDocument(self, kycDocument, userId, kycDocumentId):
         param Int/GUID KycDocument identifier
         return KycDocument from API with fileds: Id, Tag, CreationDate, Type, Status, RefusedReasonType, RefusedReasonMessage
         """
-        return self._saveObject('users_savekycdocument', kycDocument, 'KycDocument', userId, kycDocument.Id)
+        return self._saveObject('users_savekycdocument', kycDocument, 'KycDocument', userId, kycDocument.Id)
+
+    def CreateKycPageFromFile(self, userId, kycDocumentId, file):
+        """Create page for Kyc document from file
+        param int userId User identifier
+        param KycPage page Kyc
+        """
+        
+        filePath = file
+        #if (isinstance(file, collections.Sequence)):
+        #    filePath = file['tmp_name']
+        
+        if (filePath == None or filePath == ''):
+            raise Exception('Path of file cannot be empty')
+        
+        if (not os.path.isfile(filePath)):
+            raise Exception('File not exist')
+        
+        kycPage = KycPage()
+        with open(filePath) as f:
+            encoded = base64.encodestring(f.read())
+        kycPage.File = encoded
+        
+        if (kycPage.File == None):
+            raise Exception('Content of the file cannot be empty')
+        
+        self.CreateUserKycPage(kycPage, userId, kycDocumentId)
+
+    def GetBankAccountType(self, bankAccount):
+        
+        if (bankAccount.Details == None):
+            raise Exception('Details is not defined or it is not object type')
+        
+        className = bankAccount.Details.__class__.__name__.replace('BankAccountDetails', '').lower()
+
+        return className
+    

mangopaysdk/tools/enums.py

@@ -6,12 +6,12 @@ class RequestType:
 
 
 class PersonType:
-    Natural = 'NATURAL';
+    Natural = 'NATURAL'
     Legal = 'LEGAL'
 
 
 class LegalPersonType:
-    BUSINESS = 'BUSINESS';
+    BUSINESS = 'BUSINESS'
     ORGANIZATION = 'ORGANIZATION'
 
 

mangopaysdk/tools/resttool.py

@@ -2,6 +2,7 @@
 from mangopaysdk.tools.authenticationHelper import AuthenticationHelper
 from mangopaysdk.tools.urltool import UrlTool
 from mangopaysdk.types.exceptions.responseexception import ResponseException
+import sys
 
 
 class RestTool:
@@ -85,8 +86,27 @@ def _runRequest(self, urlMethod, pagination, additionalUrlParams):
 
         # load pagination info
         if not pagination == None:
-            pagination.TotalPages = int(response.headers['x-number-of-pages'])
-            pagination.TotalItems = int(response.headers['x-number-of-items'])
+            if ('x-number-of-pages' in response.headers.keys()):
+                pagination.TotalPages = int(response.headers['x-number-of-pages'])
+            if ('x-number-of-items' in response.headers.keys()):
+                pagination.TotalItems = int(response.headers['x-number-of-items'])
+
+        #try:
+        #    if not pagination == None:
+        #        pagination.TotalPages = int(response.headers['x-number-of-pages'])
+        #except:
+        #    pagination.TotalPages = 1
+        #    if self._debugMode:
+        #        logging.getLogger(__name__).debug(sys.exc_info()[0])
+        #else:
+        #    try:
+        #        if not pagination == None:
+        #            pagination.TotalItems = int(response.headers['x-number-of-items'])
+        #    except:
+        #        pagination.TotalItems = 0
+        #        if self._debugMode:
+        #            logging.getLogger(__name__).debug(sys.exc_info()[0])
+
 
         # this can hit create connection performance
         # response.connection.close()

mangopaysdk/types/bankaccountdetails.py

@@ -0,0 +1,4 @@
+from mangopaysdk.types.dto import Dto
+
+class BankAccountDetails(Dto):
+    pass

mangopaysdk/types/bankaccountdetailsca.py

@@ -0,0 +1,18 @@
+from mangopaysdk.types.bankaccountdetails import BankAccountDetails
+
+
+class BankAccountDetailsCA(BankAccountDetails):
+    """CA bank account type for BankAccount entity."""
+
+    def __init__(self):
+        self.BankName = None
+        """Bank name"""
+    
+        self.InstitutionNumber = None
+        """Institution number"""
+    
+        self.BranchCode = None
+        """Branch code"""
+    
+        self.AccountNumber = None
+        """Account number"""

mangopaysdk/types/bankaccountdetailsgb.py

@@ -0,0 +1,12 @@
+from mangopaysdk.types.bankaccountdetails import BankAccountDetails
+
+
+class BankAccountDetailsGB(BankAccountDetails):
+    """GB bank account type for BankAccount entity."""
+
+    def __init__(self):
+        self.AccountNumber = None
+        """Account number"""
+
+        self.SortCode = None
+        """Sort code"""

mangopaysdk/types/bankaccountdetailsiban.py

@@ -0,0 +1,12 @@
+from mangopaysdk.types.bankaccountdetails import BankAccountDetails
+
+
+class BankAccountDetailsIBAN(BankAccountDetails):
+    """IBAN bank account type for BankAccount entity."""
+
+    def __init__(self):
+        self.IBAN = None
+        """IBAN number"""
+
+        self.BIC = None
+        """BIC"""

mangopaysdk/types/bankaccountdetailsother.py

@@ -0,0 +1,19 @@
+from mangopaysdk.types.bankaccountdetails import BankAccountDetails
+
+
+class BankAccountDetailsOTHER(BankAccountDetails):
+    """OTHER bank account type for BankAccount entity."""
+
+    def __init__(self):
+        self.Type = None
+        """Type"""
+    
+        self.Country = None
+        """The Country associate to the BankAccount,
+        ISO 3166-1 alpha-2 format is expected"""
+    
+        self.BIC = None
+        """Valid BIC format"""
+    
+        self.AccountNumber = None
+        """Account number"""

mangopaysdk/types/bankaccountdetailsus.py

@@ -0,0 +1,12 @@
+from mangopaysdk.types.bankaccountdetails import BankAccountDetails
+
+
+class BankAccountDetailsUS(BankAccountDetails):
+    """GB bank account type for BankAccount entity."""
+
+    def __init__(self):
+        self.AccountNumber = None
+        """Account number"""
+
+        self.ABA = None
+        """ABA"""