Added support for API v2.01

Author: lukasz-drzewiecki

README.md

@@ -5,6 +5,11 @@ MangopaySDK is a Python client library to work with
 [Mangopay REST API](http://docs.mangopay.com/api-references/).
 
 
+Compatibility Note
+-------------------------------------------------
+Since v1.8 of this SDK, you must be using at least v2.01 of the API ([more information about the changes required](https://docs.mangopay.com/api-v2-01-overview/))
+
+
 Installation and package dependencies
 -------------------------------------------------
 SDK has been written in Python 2.7+ and requires:
@@ -51,7 +56,7 @@ Report bugs or suggest features using [issue tracker at GitHub](https://github.c
 Client creation example (you need to call it only once)
 -------------------------------------------------
 
-You can create you Mangopay account on https://docs.mangopay.com/api-references/sandbox-credentials/
+You can create your Mangopay account on https://docs.mangopay.com/api-references/sandbox-credentials/
 
 or with this code :
 

mangopay2-python-sdk.pyproj

@@ -66,6 +66,7 @@
     <Compile Include="mangopaysdk\tools\storages\__init__.py">
       <SubType>Code</SubType>
     </Compile>
+    <Compile Include="mangopaysdk\types\address.py" />
     <Compile Include="mangopaysdk\types\bankaccountdetails.py" />
     <Compile Include="mangopaysdk\types\bankaccountdetailsca.py" />
     <Compile Include="mangopaysdk\types\bankaccountdetailsgb.py" />

mangopaysdk/entities/bankaccount.py

@@ -1,4 +1,5 @@
 from mangopaysdk.entities.entitybase import EntityBase
+from mangopaysdk.types.address import Address
 
 
 class BankAccount(EntityBase):
@@ -17,6 +18,12 @@ def __init__(self, id = None):
         #self.BIC = None
         return super(BankAccount, self).__init__(id)
 
+    def GetSubObjects(self):
+        """Get array with mapping which property is object and what type of object.
+        return dictionary
+        """
+        return {'OwnerAddress' : 'Address'}
+
     def GetReadOnlyProperties(self):
         properties = super(BankAccount, self).GetReadOnlyProperties()
         properties.append('UserId')

mangopaysdk/entities/userlegal.py

@@ -2,6 +2,7 @@
 from mangopaysdk.entities.user import User
 from mangopaysdk.tools.enums import PersonType
 from mangopaysdk.tools.enums import KYCLevel
+from mangopaysdk.types.address import Address
 
 
 class UserLegal (User):
@@ -31,6 +32,15 @@ def __init__(self, id = None):
         self._shareholderDeclaration = None
         self._legalRepresentativeProofOfIdentity = None
 
+    def GetSubObjects(self):
+        """Get array with mapping which property is object and what type of object.
+        return dictionary
+        """
+        return {
+            'HeadquartersAddress' : 'Address',
+            'LegalRepresentativeAddress' : 'Address'
+        }
+
     def GetReadOnlyProperties(self):
         properties = super(UserLegal, self).GetReadOnlyProperties()
         properties.append('Statute' )        

mangopaysdk/entities/usernatural.py

@@ -2,6 +2,7 @@
 from mangopaysdk.entities.user import User
 from mangopaysdk.tools.enums import PersonType
 from mangopaysdk.tools.enums import KYCLevel
+from mangopaysdk.types.address import Address
 
 
 class UserNatural(User):
@@ -26,6 +27,12 @@ def __init__(self, id = None):
         self.ProofOfIdentity = None
         self.ProofOfAddress = None
 
+    def GetSubObjects(self):
+        """Get array with mapping which property is object and what type of object.
+        return dictionary
+        """
+        return {'Address' : 'Address'}
+
     def GetReadOnlyProperties(self):
         properties = super(UserNatural, self).GetReadOnlyProperties()
         properties.append('ProofOfIdentity' )        

mangopaysdk/tools/apibase.py

@@ -38,6 +38,7 @@
 from mangopaysdk.types.bankaccountdetailsca import BankAccountDetailsCA
 from mangopaysdk.types.bankaccountdetailsother import BankAccountDetailsOTHER
 from mangopaysdk.types.refundreason import RefundReason
+from mangopaysdk.types.address import Address
 from mangopaysdk.entities.temporarypaymentcard import TemporaryPaymentCard
 from mangopaysdk.entities.temporaryimmediatepayin import TemporaryImmediatePayIn
 

mangopaysdk/tools/urltool.py

@@ -15,9 +15,9 @@ def __init__ (self, config):
     def GetRestUrl(self, urlKey, addClientId = True, pagination = None, additionalUrlParams = None):
 
         if not addClientId:
-            url = '/v2' + urlKey
+            url = '/v2.01' + urlKey
         else:
-            url = '/v2/' + self._config.ClientID + urlKey
+            url = '/v2.01/' + self._config.ClientID + urlKey
 
             if pagination != None:
                 url += '?page=' + str(pagination.Page) + '&per_page=' + str(pagination.ItemsPerPage)

mangopaysdk/types/address.py

@@ -0,0 +1,13 @@
+from mangopaysdk.types.dto import Dto
+
+
+class Address(Dto):
+    """Class represents an address."""
+    
+    def __init__(self):
+        self.AddressLine1 = None
+        self.AddressLine2 = None
+        self.City = None
+        self.Region = None
+        self.PostalCode = None
+        self.Country = None

tests/testapiusers.py

@@ -13,6 +13,7 @@
 from mangopaysdk.types.bankaccountdetailsus import BankAccountDetailsUS
 from mangopaysdk.types.bankaccountdetailsca import BankAccountDetailsCA
 from mangopaysdk.types.bankaccountdetailsother import BankAccountDetailsOTHER
+from mangopaysdk.types.address import Address
 from mangopaysdk.tools.sorting import Sorting
 
 
@@ -37,6 +38,13 @@ def test_Users_CreateLegal_FailsIfRequiredPropsNotProvided(self):
 
     def test_Users_CreateLegal_PassesIfRequiredPropsProvided(self):
         user = UserLegal()
+        user.HeadquartersAddress = Address()
+        user.HeadquartersAddress.AddressLine1 = "AddressLine1"
+        user.HeadquartersAddress.AddressLine2 = "AddressLine2"
+        user.HeadquartersAddress.City = "City"
+        user.HeadquartersAddress.Country = "FR"
+        user.HeadquartersAddress.PostalCode = "11222"
+        user.HeadquartersAddress.Region = "Region"
         user.Name = "SomeOtherSampleOrg"
         user.LegalPersonType = "BUSINESS"
         user.Email = "john.doe@sample.org"

tests/testbase.py

@@ -24,6 +24,7 @@
 from mangopaysdk.types.payinpaymentdetailspreauthorized import PayInPaymentDetailsPreAuthorized
 from mangopaysdk.types.payinpaymentdetailsdirectdebit import PayInPaymentDetailsDirectDebit
 from mangopaysdk.types.money import Money
+from mangopaysdk.types.address import Address
 from mangopaysdk.tools.storages.memorystoragestrategy import MemoryStorageStrategy
 from mangopaysdk.types.pagination import Pagination
 from mangopaysdk.types.bankaccountdetailsiban import BankAccountDetailsIBAN
@@ -55,14 +56,24 @@ def buildNewMangoPayApi(self):
         sdk.OAuthTokenManager.RegisterCustomStorageStrategy(MemoryStorageStrategy())
         return sdk
 
+    def getNewAddress(self):
+        adr = Address()
+        adr.AddressLine1 = "Address line 1"
+        adr.AddressLine2 = "Address line 2"
+        adr.City = "City"
+        adr.Region = "Region"
+        adr.PostalCode = "11222"
+        adr.Country = "PL"
+        return adr
+
     def getJohn(self):
         """Creates TestBase._john (test natural user) if not created yet"""
         if (self._john == None):
             user = UserNatural()
             user.FirstName = "John"
             user.LastName = "Doe"
             user.Email = "john.doe@sample.org"
-            user.Address = "Some Address"
+            user.Address = self.getNewAddress()
             user.Birthday = int(time.mktime((1975, 12, 21, 0,0,0, -1, -1, -1)))
             user.Nationality = "FR"
             user.CountryOfResidence = "FR"
@@ -80,7 +91,7 @@ def getMatrix(self):
             user.Name = "MartixSampleOrg"
             user.Email = "john.doe@sample.org"
             user.LegalPersonType = "BUSINESS"
-            user.HeadquartersAddress = "Some Address"
+            user.HeadquartersAddress = self.getNewAddress()
             user.LegalRepresentativeFirstName = john.FirstName
             user.LegalRepresentativeLastName = john.LastName
             user.LegalRepresentativeAddress = john.Address
@@ -428,7 +439,12 @@ def assertEqualInputProps(self, entity1, entity2, asFreshlyCreated = False):
             self.assertEqual(entity1.FirstName, entity2.FirstName)
             self.assertEqual(entity1.LastName, entity2.LastName)
             self.assertEqual(entity1.Email, entity2.Email)
-            self.assertEqual(entity1.Address, entity2.Address)
+            self.assertEqual(entity1.Address.AddressLine1, entity2.Address.AddressLine1)
+            self.assertEqual(entity1.Address.AddressLine2, entity2.Address.AddressLine2)
+            self.assertEqual(entity1.Address.City, entity2.Address.City)
+            self.assertEqual(entity1.Address.Country, entity2.Address.Country)
+            self.assertEqual(entity1.Address.PostalCode, entity2.Address.PostalCode)
+            self.assertEqual(entity1.Address.Region, entity2.Address.Region)
             self.assertEqual(entity1.Birthday, entity2.Birthday)
             self.assertEqual(entity1.Nationality, entity2.Nationality)
             self.assertEqual(entity1.CountryOfResidence, entity2.CountryOfResidence)
@@ -439,7 +455,12 @@ def assertEqualInputProps(self, entity1, entity2, asFreshlyCreated = False):
             self.assertEqual(entity1.Tag, entity2.Tag)
             self.assertEqual(entity1.PersonType, entity2.PersonType)
             self.assertEqual(entity1.Name, entity2.Name)
-            self.assertEqual(entity1.HeadquartersAddress, entity2.HeadquartersAddress)
+            self.assertEqual(entity1.HeadquartersAddress.AddressLine1, entity2.HeadquartersAddress.AddressLine1)
+            self.assertEqual(entity1.HeadquartersAddress.AddressLine2, entity2.HeadquartersAddress.AddressLine2)
+            self.assertEqual(entity1.HeadquartersAddress.City, entity2.HeadquartersAddress.City)
+            self.assertEqual(entity1.HeadquartersAddress.Country, entity2.HeadquartersAddress.Country)
+            self.assertEqual(entity1.HeadquartersAddress.PostalCode, entity2.HeadquartersAddress.PostalCode)
+            self.assertEqual(entity1.HeadquartersAddress.Region, entity2.HeadquartersAddress.Region)
             self.assertEqual(entity1.LegalRepresentativeFirstName, entity2.LegalRepresentativeFirstName)
             self.assertEqual(entity1.LegalRepresentativeLastName, entity2.LegalRepresentativeLastName)
             #TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@@ -454,7 +475,12 @@ def assertEqualInputProps(self, entity1, entity2, asFreshlyCreated = False):
             self.assertEqual(entity1.UserId, entity2.UserId)
             self.assertEqual(entity1.Type, entity2.Type)
             self.assertEqual(entity1.OwnerName, entity2.OwnerName)
-            self.assertEqual(entity1.OwnerAddress, entity2.OwnerAddress)
+            self.assertEqual(entity1.OwnerAddress.AddressLine1, entity2.OwnerAddress.AddressLine1)
+            self.assertEqual(entity1.OwnerAddress.AddressLine2, entity2.OwnerAddress.AddressLine2)
+            self.assertEqual(entity1.OwnerAddress.City, entity2.OwnerAddress.City)
+            self.assertEqual(entity1.OwnerAddress.Country, entity2.OwnerAddress.Country)
+            self.assertEqual(entity1.OwnerAddress.PostalCode, entity2.OwnerAddress.PostalCode)
+            self.assertEqual(entity1.OwnerAddress.Region, entity2.OwnerAddress.Region)
             if (entity1.Type == 'IBAN'):
                 self.assertEqual(entity1.Details.IBAN, entity2.Details.IBAN)
                 self.assertEqual(entity1.Details.BIC, entity2.Details.BIC)