Merge pull request #103 from alexanderjordanbaker/AppStoreServerAPI112

alexanderjordanbaker · web-flow · commit 03859dc44585 · 2024-06-10T17:10:38.000-07:00
Add support for App Store Server API v1.12 and App Store Server Notif…
diff --git a/src/main/java/com/apple/itunes/storekit/client/AppStoreServerAPIClient.java b/src/main/java/com/apple/itunes/storekit/client/AppStoreServerAPIClient.java
@@ -264,17 +264,26 @@ public NotificationHistoryResponse getNotificationHistory(String paginationToken
         return makeHttpCall("/inApps/v1/notifications/history", "POST", queryParameters, notificationHistoryRequest, NotificationHistoryResponse.class);
     }
 
+    /**
+     * @see #getTransactionHistory(String, String, TransactionHistoryRequest, GetTransactionHistoryVersion)
+     */
+    @Deprecated(since = "2.2.0")
+    public HistoryResponse getTransactionHistory(String transactionId, String revision, TransactionHistoryRequest transactionHistoryRequest) throws APIException, IOException {
+        return this.getTransactionHistory(transactionId, revision, transactionHistoryRequest, GetTransactionHistoryVersion.V1);
+    }
+
     /**
      * Get a customer’s in-app purchase transaction history for your app.
      *
      * @param transactionId The identifier of a transaction that belongs to the customer, and which may be an original transaction identifier.
      * @param revision              A token you provide to get the next set of up to 20 transactions. All responses include a revision token. Note: For requests that use the revision token, include the same query parameters from the initial request. Use the revision token from the previous HistoryResponse.
+     * @param version The version of the Get Transaction History endpoint to use. V2 is recommended.
      * @return A response that contains the customer’s transaction history for an app.
      * @throws APIException If a response was returned indicating the request could not be processed
      * @throws IOException  If an exception was thrown while making the request
      * @see <a href="https://developer.apple.com/documentation/appstoreserverapi/get_transaction_history">Get Transaction History</a>
      */
-    public HistoryResponse getTransactionHistory(String transactionId, String revision, TransactionHistoryRequest transactionHistoryRequest) throws APIException, IOException {
+    public HistoryResponse getTransactionHistory(String transactionId, String revision, TransactionHistoryRequest transactionHistoryRequest, GetTransactionHistoryVersion version) throws APIException, IOException {
         Map<String, List<String>> queryParameters = new HashMap<>();
         if (revision != null) {
             queryParameters.put("revision", List.of(revision));
@@ -303,7 +312,7 @@ public HistoryResponse getTransactionHistory(String transactionId, String revisi
         if (transactionHistoryRequest.getRevoked() != null) {
             queryParameters.put("revoked", List.of(transactionHistoryRequest.getRevoked().toString()));
         }
-        return makeHttpCall("/inApps/v1/history/" + transactionId, "GET", queryParameters, null, HistoryResponse.class);
+        return makeHttpCall("/inApps/" + version.getUrlVersion() + "/history/" + transactionId, "GET", queryParameters, null, HistoryResponse.class);
     }
 
     /**
diff --git a/src/main/java/com/apple/itunes/storekit/client/GetTransactionHistoryVersion.java b/src/main/java/com/apple/itunes/storekit/client/GetTransactionHistoryVersion.java
@@ -0,0 +1,18 @@
+package com.apple.itunes.storekit.client;
+
+public enum GetTransactionHistoryVersion {
+
+    @Deprecated(since = "2.2.0")
+    V1("v1"),
+    V2("v2");
+
+    private final String urlVersion;
+
+    GetTransactionHistoryVersion(String urlVersion) {
+        this.urlVersion = urlVersion;
+    }
+
+    String getUrlVersion() {
+        return urlVersion;
+    }
+}
diff --git a/src/main/java/com/apple/itunes/storekit/model/JWSRenewalInfoDecodedPayload.java b/src/main/java/com/apple/itunes/storekit/model/JWSRenewalInfoDecodedPayload.java
@@ -29,6 +29,9 @@ public class JWSRenewalInfoDecodedPayload implements DecodedSignedData {
     private static final String SERIALIZED_NAME_ENVIRONMENT = "environment";
     private static final String SERIALIZED_NAME_RECENT_SUBSCRIPTION_START_DATE = "recentSubscriptionStartDate";
     private static final String SERIALIZED_NAME_RENEWAL_DATE = "renewalDate";
+    private static final String SERIALIZED_NAME_RENEWAL_PRICE = "renewalPrice";
+    private static final String SERIALIZED_NAME_CURRENCY = "currency";
+    private static final String SERIALIZED_NAME_OFFER_DISCOUNT_TYPE = "offerDiscountType";
     @JsonProperty(SERIALIZED_NAME_EXPIRATION_INTENT)
     private Integer expirationIntent;
     @JsonProperty(SERIALIZED_NAME_ORIGINAL_TRANSACTION_ID)
@@ -61,6 +64,12 @@ public class JWSRenewalInfoDecodedPayload implements DecodedSignedData {
     @JsonProperty(SERIALIZED_NAME_RENEWAL_DATE)
     @JsonDeserialize(using=XcodeCompatibleTimestampDeserializer.class)
     private Long renewalDate;
+    @JsonProperty(SERIALIZED_NAME_RENEWAL_PRICE)
+    private Long renewalPrice;
+    @JsonProperty(SERIALIZED_NAME_CURRENCY)
+    private String currency;
+    @JsonProperty(SERIALIZED_NAME_OFFER_DISCOUNT_TYPE)
+    private String offerDiscountType;
     @JsonAnySetter
     private Map<String, Object> unknownFields;
 
@@ -389,6 +398,73 @@ public void setRenewalDate(Long renewalDate) {
         this.renewalDate = renewalDate;
     }
 
+    public JWSRenewalInfoDecodedPayload renewalPrice(Long renewalPrice) {
+        this.renewalPrice = renewalPrice;
+        return this;
+    }
+
+    /**
+     * The renewal price, in milliunits, of the auto-renewable subscription that renews at the next billing period.
+     *
+     * @return renewalPrice
+     * @see <a href="https://developer.apple.com/documentation/appstoreserverapi/renewalprice">renewalPrice</a>
+     **/
+    public Long getRenewalPrice() {
+        return renewalPrice;
+    }
+
+    public void setRenewalPrice(Long renewalPrice) {
+        this.renewalPrice = renewalPrice;
+    }
+
+    public JWSRenewalInfoDecodedPayload currency(String currency) {
+        this.currency = currency;
+        return this;
+    }
+
+    /**
+     * The currency code for the renewalPrice of the subscription.
+     *
+     * @return currency
+     * @see <a href="https://developer.apple.com/documentation/appstoreserverapi/currency">currency</a>
+     **/
+    public String getCurrency() {
+        return this.currency;
+    }
+
+    public void setCurrency(String currency) {
+        this.currency = currency;
+    }
+
+    public JWSRenewalInfoDecodedPayload offerDiscountType(OfferDiscountType offerDiscountType) {
+        this.offerDiscountType = offerDiscountType != null ? offerDiscountType.getValue() : null;
+        return this;
+    }
+
+    /**
+     * The payment mode of the discount offer.
+     *
+     * @return offerDiscountType
+     * @see <a href="https://developer.apple.com/documentation/appstoreserverapi/offerdiscounttype">offerDiscountType</a>
+     **/
+    public OfferDiscountType getOfferDiscountType() {
+        return offerDiscountType != null ? OfferDiscountType.fromValue(offerDiscountType) : null;
+    }
+
+    /**
+     * @see #getOfferDiscountType()
+     */
+    public String getRawOfferDiscountType() {
+        return offerDiscountType;
+    }
+
+    public void setOfferDiscountType(OfferDiscountType offerDiscountType) {
+        this.offerDiscountType = offerDiscountType != null ? offerDiscountType.getValue() : null;
+    }
+
+    public void setRawOfferDiscountType(String rawOfferDiscountType) {
+        this.offerDiscountType = rawOfferDiscountType;
+    }
 
     public JWSRenewalInfoDecodedPayload unknownFields(Map<String, Object> unknownFields) {
         this.unknownFields = unknownFields;
@@ -431,12 +507,15 @@ public boolean equals(Object o) {
                 Objects.equals(this.environment, jwSRenewalInfoDecodedPayload.environment) &&
                 Objects.equals(this.recentSubscriptionStartDate, jwSRenewalInfoDecodedPayload.recentSubscriptionStartDate) &&
                 Objects.equals(this.renewalDate, jwSRenewalInfoDecodedPayload.renewalDate) &&
+                Objects.equals(this.renewalPrice, jwSRenewalInfoDecodedPayload.renewalPrice) &&
+                Objects.equals(this.currency, jwSRenewalInfoDecodedPayload.currency) &&
+                Objects.equals(this.offerDiscountType, jwSRenewalInfoDecodedPayload.offerDiscountType) &&
                 Objects.equals(this.unknownFields, jwSRenewalInfoDecodedPayload.unknownFields);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(expirationIntent, originalTransactionId, autoRenewProductId, productId, autoRenewStatus, isInBillingRetryPeriod, priceIncreaseStatus, gracePeriodExpiresDate, offerType, offerIdentifier, signedDate, environment, recentSubscriptionStartDate, renewalDate, unknownFields);
+        return Objects.hash(expirationIntent, originalTransactionId, autoRenewProductId, productId, autoRenewStatus, isInBillingRetryPeriod, priceIncreaseStatus, gracePeriodExpiresDate, offerType, offerIdentifier, signedDate, environment, recentSubscriptionStartDate, renewalDate, renewalPrice, currency, offerDiscountType, unknownFields);
     }
 
     @Override
@@ -456,6 +535,9 @@ public String toString() {
                 ", environment='" + environment + '\'' +
                 ", recentSubscriptionStartDate=" + recentSubscriptionStartDate +
                 ", renewalDate=" + renewalDate +
+                ", renewalPrice=" + renewalPrice +
+                ", currency='" + currency + '\'' +
+                ", offerDiscountType='" + offerDiscountType + '\'' +
                 ", unknownFields=" + unknownFields +
                 '}';
     }
diff --git a/src/main/java/com/apple/itunes/storekit/model/NotificationTypeV2.java b/src/main/java/com/apple/itunes/storekit/model/NotificationTypeV2.java
@@ -28,7 +28,8 @@ public enum NotificationTypeV2 {
     TEST("TEST"),
     RENEWAL_EXTENSION("RENEWAL_EXTENSION"),
     REFUND_REVERSED("REFUND_REVERSED"),
-    EXTERNAL_PURCHASE_TOKEN("EXTERNAL_PURCHASE_TOKEN");
+    EXTERNAL_PURCHASE_TOKEN("EXTERNAL_PURCHASE_TOKEN"),
+    ONE_TIME_CHARGE("ONE_TIME_CHARGE");
 
     private final String value;
 
diff --git a/src/test/java/com/apple/itunes/storekit/client/AppStoreServerAPIClientTest.java b/src/test/java/com/apple/itunes/storekit/client/AppStoreServerAPIClientTest.java
@@ -310,7 +310,7 @@ public void testGetNotificationHistory() throws APIException, IOException {
     }
 
     @Test
-    public void testGetTransactionHistory() throws APIException, IOException {
+    public void testGetTransactionHistoryV1() throws APIException, IOException {
         AppStoreServerAPIClient client = getClientWithBody("models/transactionHistoryResponse.json", request -> {
             Assertions.assertEquals("GET", request.method());
             Assertions.assertEquals("/inApps/v1/history/1234", request.url().encodedPath());
@@ -336,7 +336,46 @@ public void testGetTransactionHistory() throws APIException, IOException {
                 .productIds(List.of("com.example.1", "com.example.2"))
                 .subscriptionGroupIdentifiers(List.of("sub_group_id", "sub_group_id_2"));
 
-        HistoryResponse historyResponse = client.getTransactionHistory("1234", "revision_input", request);
+        HistoryResponse historyResponse = client.getTransactionHistory("1234", "revision_input", request, GetTransactionHistoryVersion.V1);
+
+        Assertions.assertNotNull(historyResponse);
+        Assertions.assertEquals("revision_output", historyResponse.getRevision());
+        Assertions.assertTrue(historyResponse.getHasMore());
+        Assertions.assertEquals("com.example", historyResponse.getBundleId());
+        Assertions.assertEquals(323232L, historyResponse.getAppAppleId());
+        Assertions.assertEquals(Environment.LOCAL_TESTING, historyResponse.getEnvironment());
+        Assertions.assertEquals("LocalTesting", historyResponse.getRawEnvironment());
+        Assertions.assertEquals(List.of("signed_transaction_value", "signed_transaction_value2"), historyResponse.getSignedTransactions());
+    }
+
+    @Test
+    public void testGetTransactionHistoryV2() throws APIException, IOException {
+        AppStoreServerAPIClient client = getClientWithBody("models/transactionHistoryResponse.json", request -> {
+            Assertions.assertEquals("GET", request.method());
+            Assertions.assertEquals("/inApps/v2/history/1234", request.url().encodedPath());
+            Assertions.assertEquals("revision_input", request.url().queryParameter("revision"));
+            Assertions.assertEquals("123455", request.url().queryParameter("startDate"));
+            Assertions.assertEquals("123456", request.url().queryParameter("endDate"));
+            Assertions.assertEquals(List.of("com.example.1", "com.example.2"), request.url().queryParameterValues("productId"));
+            Assertions.assertEquals(List.of("CONSUMABLE", "AUTO_RENEWABLE"), request.url().queryParameterValues("productType"));
+            Assertions.assertEquals("ASCENDING", request.url().queryParameter("sort"));
+            Assertions.assertEquals(List.of("sub_group_id", "sub_group_id_2"), request.url().queryParameterValues("subscriptionGroupIdentifier"));
+            Assertions.assertEquals("FAMILY_SHARED", request.url().queryParameter("inAppOwnershipType"));
+            Assertions.assertEquals("false", request.url().queryParameter("revoked"));
+            Assertions.assertNull(request.body());
+        });
+
+        TransactionHistoryRequest request = new TransactionHistoryRequest()
+                .sort(TransactionHistoryRequest.Order.ASCENDING)
+                .productTypes(List.of(TransactionHistoryRequest.ProductType.CONSUMABLE, TransactionHistoryRequest.ProductType.AUTO_RENEWABLE))
+                .endDate(123456L)
+                .startDate(123455L)
+                .revoked(false)
+                .inAppOwnershipType(InAppOwnershipType.FAMILY_SHARED)
+                .productIds(List.of("com.example.1", "com.example.2"))
+                .subscriptionGroupIdentifiers(List.of("sub_group_id", "sub_group_id_2"));
+
+        HistoryResponse historyResponse = client.getTransactionHistory("1234", "revision_input", request, GetTransactionHistoryVersion.V2);
 
         Assertions.assertNotNull(historyResponse);
         Assertions.assertEquals("revision_output", historyResponse.getRevision());
@@ -581,7 +620,7 @@ public void testDecodingWithUnknownEnumValue() throws IOException, APIException
                 .productIds(List.of("com.example.1", "com.example.2"))
                 .subscriptionGroupIdentifiers(List.of("sub_group_id", "sub_group_id_2"));
 
-        HistoryResponse historyResponse = client.getTransactionHistory("1234", "revision_input", request);
+        HistoryResponse historyResponse = client.getTransactionHistory("1234", "revision_input", request, GetTransactionHistoryVersion.V2);
 
         Assertions.assertNull(historyResponse.getEnvironment());
         Assertions.assertEquals("LocalTestingxxx", historyResponse.getRawEnvironment());
diff --git a/src/test/java/com/apple/itunes/storekit/model/JWSRenewalInfoDecodedPayloadTest.java b/src/test/java/com/apple/itunes/storekit/model/JWSRenewalInfoDecodedPayloadTest.java
@@ -38,5 +38,9 @@ public void testRenewalInfoDecoding() throws IOException, NoSuchAlgorithmExcepti
         Assertions.assertEquals("LocalTesting", renewalInfo.getRawEnvironment());
         Assertions.assertEquals(1698148800000L, renewalInfo.getRecentSubscriptionStartDate());
         Assertions.assertEquals(1698148850000L, renewalInfo.getRenewalDate());
+        Assertions.assertEquals(9990, renewalInfo.getRenewalPrice());
+        Assertions.assertEquals("USD", renewalInfo.getCurrency());
+        Assertions.assertEquals(OfferDiscountType.PAY_AS_YOU_GO, renewalInfo.getOfferDiscountType());
+        Assertions.assertEquals("PAY_AS_YOU_GO", renewalInfo.getRawOfferDiscountType());
     }
 }
diff --git a/src/test/resources/models/signedRenewalInfo.json b/src/test/resources/models/signedRenewalInfo.json
@@ -12,5 +12,8 @@
   "signedDate": 1698148800000,
   "environment": "LocalTesting",
   "recentSubscriptionStartDate": 1698148800000,
-  "renewalDate": 1698148850000
+  "renewalDate": 1698148850000,
+  "renewalPrice": 9990,
+  "currency": "USD",
+  "offerDiscountType": "PAY_AS_YOU_GO"
 }

Original file line number	Diff line number	Diff line change
`@@ -38,5 +38,9 @@ public void testRenewalInfoDecoding() throws IOException, NoSuchAlgorithmExcepti`
`38`	`38`	`Assertions.assertEquals("LocalTesting", renewalInfo.getRawEnvironment());`
`39`	`39`	`Assertions.assertEquals(1698148800000L, renewalInfo.getRecentSubscriptionStartDate());`
`40`	`40`	`Assertions.assertEquals(1698148850000L, renewalInfo.getRenewalDate());`
	`41`	`+ Assertions.assertEquals(9990, renewalInfo.getRenewalPrice());`
	`42`	`+ Assertions.assertEquals("USD", renewalInfo.getCurrency());`
	`43`	`+ Assertions.assertEquals(OfferDiscountType.PAY_AS_YOU_GO, renewalInfo.getOfferDiscountType());`
	`44`	`+ Assertions.assertEquals("PAY_AS_YOU_GO", renewalInfo.getRawOfferDiscountType());`
`41`	`45`	`}`
`42`	`46`	`}`