Merge pull request #9 from kt81/feat/lookUpOrderId

feat: LookUpOrderId API

Author: flagbug

README.md

@@ -25,7 +25,7 @@ This is a list of the features that are currently implemented in the library, co
 | Get Transaction History v1                                  |  ✅   |              |
 | Get Transaction Info                                        |  ✅   |      ✅      |
 | Send Consumption Information                                |  ✅   |      ✅      |
-| Look Up Order ID                                            |  ✅   |              |
+| Look Up Order ID                                            |  ✅   |      ✅      |
 | Get Refund History                                          |  ✅   |              |
 | Extending the renewal date for auto-renewable subscriptions |  ✅   |              |
 | Request a Test Notification                                 |  ✅   |              |

src/AppStoreServerApiClient.cs

@@ -114,6 +114,14 @@ public Task SendConsumptionData(string transactionId, ConsumptionRequest consump
         return this.MakeRequest<TransactionInfoResponse>(path, HttpMethod.Get);
     }
 
+    public Task<OrderLookupResponse> LookUpOrderId(string orderId)
+    {
+        //Call to https://developer.apple.com/documentation/appstoreserverapi/look_up_order_id
+        string path = $"/inApps/v1/lookup/{orderId}";
+
+        return this.MakeRequest<OrderLookupResponse>(path, HttpMethod.Get)!;
+    }
+
     private static string CreateBearerToken(string keyId, string issuerId, string signingKey, string bundleId)
     {
         var prvKey = ECDsa.Create();

src/Models/AppStoreDataTypes.cs

@@ -611,6 +611,31 @@ public class TransactionInfoResponse
     public string SignedTransactionInfo { get; set; } = null!;
 }
 
+/// <summary>
+/// A response that includes the order lookup status and an array of signed transactions for the in-app purchases in the order.
+/// </summary>
+public class OrderLookupResponse
+{
+    public OrderLookupStatus Status { get; set; }
+    public List<string> SignedTransactions { get; set; } = null!;
+}
+
+/// <summary>
+/// A value that indicates whether the order ID in the request is valid for your app.
+/// </summary>
+public enum OrderLookupStatus
+{
+    /// <summary>
+    /// Valid
+    /// </summary>
+    Valid = 0,
+
+    /// <summary>
+    /// Invalid
+    /// </summary>
+    Invalid = 1,
+}
+
 /// <summary>
 /// Error response from the App Store Server API.
 /// </summary>

tests/AppStoreServerApiClientTest.cs

@@ -151,4 +151,35 @@ public async Task GetTransactionInfo_Success()
         Assert.NotNull(response);
         Assert.Equal("signed_transaction_info_value", response.SignedTransactionInfo);
     }
+
+    [Fact]
+    public async Task LookUpOrderId_Success()
+    {
+        const string responseData = """
+            {
+              "status": 1,
+              "signedTransactions": [
+                "signed_transaction_one",
+                "signed_transaction_two"
+              ]
+            }
+            """;
+
+        var mockHttp = new MockHttpMessageHandler();
+        mockHttp
+            .When($"https://local-testing-base-url/inApps/v1/lookup/W002182")
+            .Respond("application/json", responseData);
+
+        AppStoreServerApiClient client = GetAppStoreServerApiClient(mockHttp);
+
+        OrderLookupResponse response = await client.LookUpOrderId("W002182");
+
+        Assert.NotNull(response);
+        Assert.Equal(OrderLookupStatus.Invalid, response.Status);
+        Assert.Collection(
+            response.SignedTransactions,
+            transaction => Assert.Equal("signed_transaction_one", transaction),
+            transaction => Assert.Equal("signed_transaction_two", transaction)
+        );
+    }
 }