UsCompany response converter (#395)

* Added entityDetailsResponse check * Mods at unit testing for USCompany * Removed line comment * Fixed breaking lines
checkout · May 16, 2024 · 808c043 · 808c043
1 parent af1bea3
commit 808c043
Show file tree

Hide file tree

Showing 13 changed files with 364 additions and 5 deletions.
diff --git a/src/CheckoutSdk/Accounts/Company.cs b/src/CheckoutSdk/Accounts/Company.cs
@@ -1,4 +1,6 @@
-using Checkout.Common;
+using Checkout.Accounts.Regional;
+using Checkout.Common;
+using Newtonsoft.Json;
 using System.Collections.Generic;
 
 namespace Checkout.Accounts

diff --git a/src/CheckoutSdk/Accounts/IAccountsClient.cs b/src/CheckoutSdk/Accounts/IAccountsClient.cs
@@ -1,5 +1,6 @@
 using Checkout.Accounts.Payout.Request;
 using Checkout.Accounts.Payout.Response;
+using Checkout.Accounts.Regional.US;
 using Checkout.Common;
 using System;
 using System.Threading;

diff --git a/src/CheckoutSdk/Accounts/OnboardEntityDetailsResponse.cs b/src/CheckoutSdk/Accounts/OnboardEntityDetailsResponse.cs
@@ -1,4 +1,6 @@
-using Checkout.Common;
+using Checkout.Accounts.Regional;
+using Checkout.Common;
+using Newtonsoft.Json;
 using System.Collections.Generic;
 
 namespace Checkout.Accounts
@@ -18,7 +20,7 @@ public class OnboardEntityDetailsResponse : Resource
         public ContactDetails ContactDetails { get; set; }
 
         public Profile Profile { get; set; }
-
+        
         public Company Company { get; set; }
 
         public Individual Individual { get; set; }

diff --git a/src/CheckoutSdk/Accounts/Regional/CompanyTypeConverter.cs b/src/CheckoutSdk/Accounts/Regional/CompanyTypeConverter.cs
@@ -0,0 +1,65 @@
+using Checkout.Accounts.Regional.US;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using System;
+using System.Reflection;
+
+namespace Checkout.Accounts.Regional
+{
+    public class CompanyTypeConverter : JsonConverter
+    {
+        public override bool CanWrite => false;
+
+        public override bool CanConvert(Type objectType)
+        {
+            return typeof(OnboardEntityDetailsResponse).GetTypeInfo().IsAssignableFrom(objectType.GetTypeInfo());
+        }
+
+        public override void WriteJson(
+            JsonWriter writer,
+            object value,
+            Newtonsoft.Json.JsonSerializer serializer)
+        {
+            throw new NotImplementedException();
+        }
+
+        public override object ReadJson(
+            JsonReader reader,
+            Type objectType,
+            object existingValue,
+            Newtonsoft.Json.JsonSerializer serializer)
+        {
+
+            if (reader.TokenType == JsonToken.Null)
+                return null;
+
+            var jObject = JToken.Load(reader);
+            if (jObject.Type == JTokenType.Object)
+            {
+                var businessTypeToken = jObject["company"]?["business_type"];
+                if (businessTypeToken != null && businessTypeToken.Type == JTokenType.String )
+                {
+                    var enumString = businessTypeToken.Value<string>();
+
+                    var businessType = CheckoutUtils.GetEnumFromStringMemberValue<BusinessType>(enumString);
+                    if (businessType != null)
+                    {
+                        var target = new OnboardEntityDetailsResponse();
+                        serializer.Populate(jObject.CreateReader(), target);
+                        return target;
+                    }
+
+                    var usBusinessType = CheckoutUtils.GetEnumFromStringMemberValue<USBusinessType>(enumString);
+                    if (usBusinessType != null)
+                    {
+                        var target = new OnboardEntityDetailsUSCompanyResponse();
+                        serializer.Populate(jObject.CreateReader(), target);
+                        return target;
+                    }
+                }
+            }
+
+            throw new JsonSerializationException($"Unexpected token or value when parsing enum. Token: {reader.TokenType}, Value: {jObject}");
+        }
+    }
+}
diff --git a/src/CheckoutSdk/Accounts/Regional/US/OnboardEntityDetailsUSCompanyResponse.cs b/src/CheckoutSdk/Accounts/Regional/US/OnboardEntityDetailsUSCompanyResponse.cs
@@ -0,0 +1,7 @@
+namespace Checkout.Accounts.Regional.US
+{
+    public class OnboardEntityDetailsUSCompanyResponse : OnboardEntityDetailsResponse
+    {
+        public new USCompany Company { get; set; }
+    }
+}
diff --git a/src/CheckoutSdk/Accounts/Regional/US/USCompany.cs b/src/CheckoutSdk/Accounts/Regional/US/USCompany.cs
@@ -1,4 +1,6 @@
-namespace Checkout.Accounts.Regional.US
+using Newtonsoft.Json;
+
+namespace Checkout.Accounts.Regional.US
 {
     public class USCompany : Company
     {

diff --git a/src/CheckoutSdk/JsonSerializer.cs b/src/CheckoutSdk/JsonSerializer.cs
@@ -1,4 +1,5 @@
 using Checkout.Accounts.Payout.Response.Util;
+using Checkout.Accounts.Regional;
 using Checkout.Instruments.Create.Util;
 using Checkout.Instruments.Get.Util;
 using Checkout.Instruments.Update.Util;
@@ -50,6 +51,7 @@ private static JsonSerializerSettings CreateSerializerSettings(Action<JsonSerial
                 ContractResolver = new DefaultContractResolver { NamingStrategy = new SnakeCaseNamingStrategy() },
                 Converters = new JsonConverter[]
                 {
+                    new CompanyTypeConverter(),
                     new StringEnumConverter(),
                     // Instruments CS2
                     new CreateInstrumentResponseTypeConverter(),

diff --git a/test/CheckoutSdkTest/Accounts/AccountsClientTest.cs b/test/CheckoutSdkTest/Accounts/AccountsClientTest.cs
@@ -198,6 +198,7 @@ private async Task ShouldUpdateEntityUsCompany()
             response.ShouldNotBeNull();
             response.Id.ShouldBe(responseObject.Id);
             response.Reference.ShouldBe(responseObject.Reference);
+
         }
 
         [Fact]

diff --git a/test/CheckoutSdkTest/Accounts/AccountsIntegrationTest.cs b/test/CheckoutSdkTest/Accounts/AccountsIntegrationTest.cs
@@ -1,3 +1,4 @@
+using Checkout.Accounts.Regional.US;
 using Checkout.Common;
 using Checkout.Instruments;
 using Shouldly;
@@ -89,7 +90,7 @@ public async Task ShouldCreateGetAndUpdateOnboardEntity()
             verifyUpdated.ShouldNotBeNull();
             onboardEntityRequest.Individual.FirstName.ShouldBe(verifyUpdated.Individual.FirstName);
         }
-        
+
         [Fact(Skip = "unavailable")]
         public async Task ShouldThrowConflictWhenCreatingExistingEntity()
         {
@@ -209,6 +210,82 @@ private async Task ShouldCreateAndRetrievePaymentInstrument()
             queryResponse.ShouldNotBeNull();
             queryResponse.Data.ShouldNotBeNull();
         }
+
+
+        [Fact]
+        private async Task ShouldCreateAndRetrievePaymentInstrumentUSCompany()
+        {
+            CheckoutApi api = GetAccountsCheckoutApi();
+
+            var entityRequest = new OnboardEntityRequest
+            {
+                Reference = RandomString(15),
+                ContactDetails = BuildContactDetails(),
+                Profile = BuildProfile(),
+                Company = new USCompany()
+                {
+                    BusinessRegistrationNumber = "01234567",
+                    BusinessType = USBusinessType.PrivateCorporation,
+                    LegalName = "Super Hero Masks Inc.",
+                    TradingName = "Super Hero Masks",
+                    PrincipalAddress = GetAddress(),
+                    RegisteredAddress = GetAddress(),
+                    Representatives = new List<Representative>
+                    {
+                        new Representative
+                        {
+                            FirstName = "John",
+                            LastName = "Doe",
+                            Address = GetAddress(),
+                            Identification = new Identification { NationalIdNumber = "AB123456C", }
+                        }
+                    }
+                }
+            };
+
+            var entityResponse = await api.AccountsClient().CreateEntity(entityRequest);
+
+            var entityDetailsResponse = await api.AccountsClient().GetEntity(entityResponse.Id);
+
+            var file = await UploadFile();
+
+            var instrumentRequest = new PaymentInstrumentRequest
+            {
+                Label = "Barclays",
+                Type = InstrumentType.BankAccount,
+                Currency = Currency.GBP,
+                Country = CountryCode.GB,
+                DefaultDestination = false,
+                Document = new InstrumentDocument { Type = "bank_statement", FileId = file.Id },
+                InstrumentDetails = new InstrumentDetailsFasterPayments
+                {
+                    AccountNumber = "12334454", BankCode = "050389"
+                }
+            };
+
+            var instrumentResponse = await api.AccountsClient().CreatePaymentInstrument(entityResponse.Id, instrumentRequest);
+            instrumentResponse.ShouldNotBeNull();
+            instrumentResponse.Id.ShouldNotBeNull();
+
+            entityDetailsResponse.ShouldNotBeNull();
+
+            var instrumentDetails = await api.AccountsClient().RetrievePaymentInstrumentDetails(entityResponse.Id, instrumentResponse.Id);
+            instrumentDetails.ShouldNotBeNull();
+            instrumentDetails.Id.ShouldNotBeNull();
+            instrumentDetails.Status.ShouldNotBeNull();
+            instrumentDetails.Label.ShouldNotBeNull();
+            instrumentDetails.Type.ShouldNotBeNull();
+            instrumentDetails.Currency.ShouldNotBeNull();
+            instrumentDetails.Country.ShouldNotBeNull();
+            instrumentDetails.Document.ShouldNotBeNull();
+
+            var queryResponse = await api.AccountsClient().QueryPaymentInstruments(entityResponse.Id);
+            queryResponse.ShouldNotBeNull();
+            queryResponse.Data.ShouldNotBeNull();
+        }
+
+
+
 
         private static string RandomString(int length)
         {

diff --git a/test/CheckoutSdkTest/CheckoutSdkTest.csproj b/test/CheckoutSdkTest/CheckoutSdkTest.csproj
@@ -85,6 +85,17 @@
         <Content Include="Resources\get_financial_actions_response.json">
           <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
         </Content>
+        <None Remove="Resources\OnBoardSubEntityCompanyResponse.json" />
+        <Content Include="Resources\OnBoardSubEntityCompanyResponse.json">
+            <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+        </Content>
+        <None Remove="Resources\OnBoardSubEntityUSCompanyResponse.json" />
+        <Content Include="Resources\OnBoardSubEntityUSCompanyResponse.json">
+          <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+        </Content>
+        <Content Update="Resources\OnBoardSubEntityCompanyResponse.json">
+          <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+        </Content>
     </ItemGroup>
     <ItemGroup>
       <Folder Include="Apm\Previous" />

diff --git a/test/CheckoutSdkTest/JsonSerializerTest.cs b/test/CheckoutSdkTest/JsonSerializerTest.cs
@@ -1,3 +1,5 @@
+using Checkout.Accounts;
+using Checkout.Accounts.Regional.US;
 using Checkout.Financial;
 using Checkout.Issuing.Cards;
 using Checkout.Issuing.Cards.Requests.Create;
@@ -126,6 +128,28 @@ public void ShouldSerializeDateTimeFormatsFromJson()
             financialActionsQueryResponse.ShouldNotBeNull();
             financialActionsQueryResponse.Data[0].ProcessedOn.ShouldNotBeNull();
         }
+
+        [Fact]
+        public void ShouldSerializeOnBoardSubEntityCompanyFromJson()
+        {
+            var fileContent = GetJsonFileContent("./Resources/OnBoardSubEntityCompanyResponse.json");
+            OnboardEntityDetailsResponse onboardEntityDetailsResponse =
+                (OnboardEntityDetailsResponse)new JsonSerializer().Deserialize(fileContent,
+                    typeof(OnboardEntityDetailsResponse));
+            onboardEntityDetailsResponse.ShouldNotBeNull();
+            onboardEntityDetailsResponse.Company.BusinessType.ShouldBeOfType<BusinessType>();
+        }
+
+        [Fact]
+        public void ShouldSerializeOnBoardSubEntityUSCompanyFromJson()
+        {
+            var fileContent = GetJsonFileContent("./Resources/OnBoardSubEntityUSCompanyResponse.json");
+            OnboardEntityDetailsUSCompanyResponse onboardEntityDetailsResponse =
+                (OnboardEntityDetailsUSCompanyResponse)new JsonSerializer().Deserialize(fileContent,
+                    typeof(OnboardEntityDetailsUSCompanyResponse));
+            onboardEntityDetailsResponse.ShouldNotBeNull();
+            onboardEntityDetailsResponse.Company.BusinessType.ShouldBeOfType<USBusinessType>();
+        }
 
         [Fact]
         public void ShouldDeserializeDateTimeFormatsFromStrings()

diff --git a/test/CheckoutSdkTest/Resources/OnBoardSubEntityCompanyResponse.json b/test/CheckoutSdkTest/Resources/OnBoardSubEntityCompanyResponse.json
@@ -0,0 +1,69 @@
+{
+  "id": "ent_saf19jffasdf",
+  "contact_details": {
+    "phone": {
+      "number": "2345678910"
+    },
+    "email_addresses": {
+      "primary": "[email protected]"
+    }
+  },
+  "profile": {
+    "urls": [
+      "https://www.superheroexample.com"
+    ],
+    "mccs": [
+      "5311"
+    ],
+    "default_holding_currency": "GBP",
+    "holding_currencies": [
+      "GBP"
+    ]
+  },
+  "company": {
+    "business_registration_number": "12345678",
+    "business_type": "public_limited_company",
+    "legal_name": "Acme Corporation Inc.",
+    "trading_name": "Acme Corporation",
+    "principal_address": {
+      "address_line1": "Flat 456",
+      "city": "London",
+      "zip": "SW1A 1AA",
+      "country": "GB"
+    },
+    "registered_address": {
+      "address_line1": "Flat 456",
+      "city": "London",
+      "zip": "SW1A 1AA",
+      "country": "GB"
+    },
+    "representatives": [
+      {
+        "id": "rep_1d1j98j1h991dlkjdajsjd",
+        "first_name": "John",
+        "last_name": "Smith",
+        "address": {
+          "address_line1": "Flat 456",
+          "city": "London",
+          "zip": "SW1A 1AA",
+          "country": "GB"
+        },
+        "identification": {
+          "national_id_number": "AB123456C",
+          "document": {
+            "type": "driving_license",
+            "front": "file_wxglze3wwywujg4nna5fb7ldli",
+            "back": "file_adglze3wwywujg4nna5fb7l1sg"
+          }
+        },
+        "phone": {
+          "number": "2345678910"
+        },
+        "roles": [
+          "authorised_signatory",
+          "ubo"
+        ]
+      }
+    ]
+  }
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -198,6 +198,7 @@ private async Task ShouldUpdateEntityUsCompany() @@
                 response.ShouldNotBeNull();
                 response.Id.ShouldBe(responseObject.Id);
                 response.Reference.ShouldBe(responseObject.Reference);
             }
             [Fact]
@@ Expand Down @@