allow PayoutTransaction listing to have source expanded

Author: mguzowski-shift4

.github/workflows/build.yml

@@ -6,52 +6,85 @@ jobs:
 
   build:
     name: Build lib
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-dotnet@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-dotnet@v4
         with:
           dotnet-version: 3.1.x
       - name: Create NuGet package
         run: dotnet pack Shift4 -c Release
+        env:
+          DOTNET_SYSTEM_GLOBALIZATION_INVARIANT: 1
       - name: Upload NuGet package as artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: nuget-package
           path: Shift4/bin/Release/Shift4.*.nupkg
           if-no-files-found: error
           retention-days: 30
 
-  test:
+  test31:
     needs: build
     env:
       SECRET_KEY: ${{ secrets.SECRET_KEY }}
-    name: Run tests
-    runs-on: ubuntu-latest
+    name: Run tests 3.1.x
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 3.1.x
+      - name: Run tests 3.1.x
+        run: dotnet test -p:TargetFramework=netcoreapp3.1
+        env:
+          DOTNET_SYSTEM_GLOBALIZATION_INVARIANT: 1
+
+  test60:
+    needs: [build, test31]
+    env:
+      SECRET_KEY: ${{ secrets.SECRET_KEY }}
+    name: Run tests 6.0.x
+    runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-dotnet@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-dotnet@v4
         with:
-          dotnet-version: |
-            3.1.x
-            6.0.x
-            7.0.x
-      - name: Run tests
-        run: dotnet test
+          dotnet-version: 6.0.x
+      - name: Run tests 6.0.x
+        run: dotnet test -p:TargetFramework=net6.0
+        env:
+          DOTNET_SYSTEM_GLOBALIZATION_INVARIANT: 1
+
+  test70:
+    needs: [build, test31, test60]
+    env:
+      SECRET_KEY: ${{ secrets.SECRET_KEY }}
+    name: Run tests 7.0.x
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 7.0.x
+      - name: Run tests 7.0.x
+        run: dotnet test -p:TargetFramework=netcoreapp7.0
+        env:
+          DOTNET_SYSTEM_GLOBALIZATION_INVARIANT: 1
 
   nuget-publish:
     if: startsWith(github.event.ref, 'refs/tags/v')
-    needs: [build, test]
+    needs: [build, test31, test60, test70]
     name: Publish package to nuget.org
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     env:
       NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }}
     steps:
-      - uses: actions/setup-dotnet@v3
+      - uses: actions/setup-dotnet@v4
         with:
           dotnet-version: 3.1.x
       - name: Download build artifacts
-        uses: actions/download-artifact@v3      
+        uses: actions/download-artifact@v4
         with:
           name: nuget-package
       - name: Publish package to nuget.org
@@ -60,11 +93,11 @@ jobs:
 
   create-release:
     if: startsWith(github.event.ref, 'refs/tags/v')
-    needs: [build, test]
+    needs: [build, test31, test60, test70]
     name: Create Release
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: nuget-package
       - name: Create Release

Shift4/Converters/BaseObjectTypeConverter.cs

@@ -0,0 +1,57 @@
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using Shift4.Response;
+
+namespace Shift4.Converters
+{
+    public abstract class BaseObjectTypeConverter : JsonConverter
+    {
+        protected BaseIdResponse convertObjectType(JsonReader reader, JsonSerializer serializer) {
+            JObject jObject = JObject.Load(reader);
+            switch (jObject.GetValue("objectType").ToString())
+            {
+                case "charge":
+                    var charge = new Charge();
+                    serializer.Populate(jObject.CreateReader(), charge);
+                    return charge;
+                case "credit":
+                    var credit = new Credit();
+                    serializer.Populate(jObject.CreateReader(), credit);
+                    return credit;
+                case "dispute":
+                    var dispute = new Dispute();
+                    serializer.Populate(jObject.CreateReader(), dispute);
+                    return dispute;
+                case "refund":
+                    var refund = new Refund();
+                    serializer.Populate(jObject.CreateReader(), refund);
+                    return refund;
+                case "subscription":
+                    var subscription = new Subscription();
+                    serializer.Populate(jObject.CreateReader(), subscription);
+                    return subscription;
+                case "plan":
+                    var plan = new Plan();
+                    serializer.Populate(jObject.CreateReader(), plan);
+                    return plan;
+                case "customer":
+                    var customer = new Customer();
+                    serializer.Populate(jObject.CreateReader(), customer);
+                    return customer;
+                case "fraud_warning":
+                    var warning = new FraudWarning();
+                    serializer.Populate(jObject.CreateReader(), warning);
+                    return warning;
+                case "card":
+                    var card = new Card();
+                    serializer.Populate(jObject.CreateReader(), card);
+                    return card;
+                case "payout":
+                    var payout = new Payout();
+                    serializer.Populate(jObject.CreateReader(), payout);
+                    return payout;
+            }
+            return null;
+        }
+    }
+}

Shift4/Converters/EventDataConverter.cs

@@ -1,14 +1,9 @@
 using Newtonsoft.Json;
-using Newtonsoft.Json.Linq;
-using Shift4.Response;
 using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
 
 namespace Shift4.Converters
 {
-    public class EventDataConverter : JsonConverter
+    public class EventDataConverter : BaseObjectTypeConverter
     {
 
         public override bool CanConvert(Type objectType)
@@ -18,48 +13,7 @@ public override bool CanConvert(Type objectType)
 
         public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
         {
-            JObject jObject = JObject.Load(reader);
-            switch (jObject.GetValue("objectType").ToString())
-            {
-                case "charge":
-                    var charge = new Charge();
-                    serializer.Populate(jObject.CreateReader(), charge);
-                    return charge;
-                case "credit":
-                    var credit = new Credit();
-                    serializer.Populate(jObject.CreateReader(), credit);
-                    return credit;
-                case "dispute":
-                    var dispute = new Dispute();
-                    serializer.Populate(jObject.CreateReader(), dispute);
-                    return dispute;
-                case "subscription":
-                    var subscription = new Subscription();
-                    serializer.Populate(jObject.CreateReader(), subscription);
-                    return subscription;
-                case "plan":
-                    var plan = new Plan();
-                    serializer.Populate(jObject.CreateReader(), plan);
-                    return plan;
-                case "customer":
-                    var customer = new Customer();
-                    serializer.Populate(jObject.CreateReader(), customer);
-                    return customer;
-                case "fraud_warning":
-                    var warning = new FraudWarning();
-                    serializer.Populate(jObject.CreateReader(), warning);
-                    return warning;
-                case "card":
-                    var card = new Card();
-                    serializer.Populate(jObject.CreateReader(), card);
-                    return card;
-                case "payout":
-                    var payout = new Payout();
-                    serializer.Populate(jObject.CreateReader(), payout);
-                    return payout;
-            }
-
-            return null;
+            return convertObjectType(reader, serializer);
         }
 
         public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)

Shift4/Converters/ExpandConverter.cs

@@ -0,0 +1,27 @@
+
+using System;
+using Newtonsoft.Json;
+using Shift4.Request;
+
+namespace Shift4.Converters
+{
+    public class ExpandConverter : JsonConverter<Expand>
+    {
+        public override Expand ReadJson(JsonReader reader, Type objectType, Expand existingValue, bool hasExistingValue, JsonSerializer serializer)
+        {
+            return null;
+        }
+
+        public override void WriteJson(JsonWriter writer, Expand value, JsonSerializer serializer)
+        {
+            if (value == null || value.Paths.Count == 0) {
+                return;
+            }
+            writer.WriteStartArray();
+            value.Paths.ForEach(path => {
+                writer.WriteValue(path);
+            });
+            writer.WriteEndArray();
+        }
+    }
+}

Shift4/Converters/ExpandableConverter.cs

@@ -0,0 +1,33 @@
+using System;
+using Newtonsoft.Json;
+using Shift4.Response;
+
+namespace Shift4.Converters
+{
+    public class ExpandableConverter<T> : BaseObjectTypeConverter where T: BaseIdResponse
+    {
+        public override bool CanConvert(Type objectType) => objectType.IsInstanceOfType(typeof(Expandable<T>));
+    
+
+        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
+        {
+            if (reader.TokenType == JsonToken.String)
+        {
+            // Case: JSON contains a string
+            return new Expandable<T> { Id = reader.Value.ToString() };
+        }
+        else if (reader.TokenType == JsonToken.StartObject)
+        {
+            var deserializedObject = convertObjectType(reader, serializer);
+            return new Expandable<T> { ExpandedObject = (T)deserializedObject };
+        }
+
+        throw new JsonSerializationException("Unexpected token type");
+
+        }
+
+        public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
+        {
+        }
+    }
+}

Shift4/Internal/ApiClient.cs

@@ -17,7 +17,7 @@ public class ApiClient : IApiClient
         private string _privateAuthToken;
         private IHttpClient _client;
         private IFileExtensionToMimeMapper _fileExtensionToMimeMapper;
-        private string _sdkVersion = "3.7.0";
+        private string _sdkVersion = "3.8.0";
 
         public ApiClient(IHttpClient httpClient, ISecretKeyProvider secretKeyProvider, IFileExtensionToMimeMapper fileExtensionToMimeMapper)
         {

Shift4/Request/Expand.cs

@@ -0,0 +1,18 @@
+using System.Collections.Generic;
+using Org.BouncyCastle.Asn1.Mozilla;
+
+namespace Shift4.Request
+{
+    public class Expand {
+	    public List<string> Paths {get; set; }
+
+        public Expand() {
+            Paths = new List<string>();
+        }
+
+        public Expand add(string path){
+            Paths.Add(path);
+            return this;
+        }
+    }
+}

Shift4/Request/PayoutTransactionListRequest.cs

@@ -1,7 +1,9 @@
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
+using Shift4.Converters;
 using System;
 using System.Collections.Generic;
+using System.Dynamic;
 using System.Linq;
 using System.Text;
 
@@ -14,5 +16,18 @@ public class PayoutTransactionListRequest : ListRequest
 
        [JsonProperty("source")]
         public String Source { get; set; }
+
+        [JsonProperty("expand")]
+        [JsonConverter(typeof(ExpandConverter))]
+        public Expand Expand { get; }
+
+        public PayoutTransactionListRequest() {
+            Expand = new Expand();
+        }
+
+        public PayoutTransactionListRequest expandSource() {
+            this.Expand.add("source");
+            return this;
+        }
     }
 }

Shift4/Response/BaseIdResponse.cs

@@ -0,0 +1,17 @@
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using System;
+using Shift4.Converters;
+
+namespace Shift4.Response
+{
+    public abstract class BaseIdResponse: BaseResponse
+    {
+        [JsonProperty("id")]
+        public string Id { get; set; }
+
+        [JsonProperty("created")]
+        [JsonConverter(typeof(DateConverter))]
+        public DateTime Created { get; set; }
+    }
+}