Merge pull request #85 from alexanderjordanbaker/ASSAv1.11

Add support for App Store Server API v1.11 and App Store Server Notif…

Author: alexanderjordanbaker

appstoreserverlibrary/api_client.py

@@ -308,6 +308,15 @@ class APIError(IntEnum):
     An error that indicates the transaction identifier doesn’t represent a consumable in-app purchase.
     
     https://developer.apple.com/documentation/appstoreserverapi/invalidtransactionnotconsumableerror
+
+    .. deprecated:: 1.11
+    """
+
+    INVALID_TRANSACTION_TYPE_NOT_SUPPORTED = 4000047
+    """
+    An error that indicates the transaction identifier represents an unsupported in-app purchase type.
+    
+    https://developer.apple.com/documentation/appstoreserverapi/invalidtransactiontypenotsupportederror
     """
 
     SUBSCRIPTION_EXTENSION_INELIGIBLE = 4030004

appstoreserverlibrary/models/ConsumptionRequest.py

@@ -12,6 +12,7 @@
 from .LifetimeDollarsRefunded import LifetimeDollarsRefunded
 from .Platform import Platform
 from .PlayTime import PlayTime
+from .RefundPreference import RefundPreference
 from .UserStatus import UserStatus
 
 @define
@@ -137,4 +138,16 @@ class ConsumptionRequest(AttrsRawValueAware):
     rawUserStatus: Optional[int] = UserStatus.create_raw_attr('userStatus')
     """
     See userStatus
+    """
+
+    refundPreference: Optional[RefundPreference] =  RefundPreference.create_main_attr('rawRefundPreference')
+    """
+    A value that indicates your preference, based on your operational logic, as to whether Apple should grant the refund.
+    
+    https://developer.apple.com/documentation/appstoreserverapi/refundpreference
+    """
+
+    rawRefundPreference: Optional[int] = RefundPreference.create_raw_attr('refundPreference')
+    """
+    See refundPreference
     """

appstoreserverlibrary/models/ConsumptionRequestReason.py

@@ -0,0 +1,17 @@
+# Copyright (c) 2024 Apple Inc. Licensed under MIT License.
+
+from enum import Enum
+
+from .LibraryUtility import AppStoreServerLibraryEnumMeta
+
+class ConsumptionRequestReason(str, Enum, metaclass=AppStoreServerLibraryEnumMeta):
+    """
+    The customer-provided reason for a refund request.
+    
+    https://developer.apple.com/documentation/appstoreservernotifications/consumptionrequestreason
+    """
+    UNINTENDED_PURCHASE = "UNINTENDED_PURCHASE"
+    FULFILLMENT_ISSUE = "FULFILLMENT_ISSUE"
+    UNSATISFIED_WITH_PURCHASE = "UNSATISFIED_WITH_PURCHASE"
+    LEGAL = "LEGAL"
+    OTHER = "OTHER"

appstoreserverlibrary/models/Data.py

@@ -4,6 +4,7 @@
 from attr import define
 import attr
 
+from .ConsumptionRequestReason import ConsumptionRequestReason
 from .Environment import Environment
 from .Status import Status
 from .LibraryUtility import AttrsRawValueAware
@@ -71,4 +72,16 @@ class Data(AttrsRawValueAware):
     rawStatus: Optional[int] = Status.create_raw_attr('status')
     """
     See status
+    """
+
+    consumptionRequestReason: Optional[ConsumptionRequestReason] = ConsumptionRequestReason.create_main_attr('rawConsumptionRequestReason')
+    """
+    The reason the customer requested the refund.
+    
+    https://developer.apple.com/documentation/appstoreservernotifications/consumptionrequestreason
+    """
+
+    rawConsumptionRequestReason: Optional[str] = ConsumptionRequestReason.create_raw_attr('consumptionRequestReason')
+    """
+    See consumptionRequestReason
     """

appstoreserverlibrary/models/NotificationTypeV2.py

@@ -6,7 +6,7 @@
 
 class NotificationTypeV2(str, Enum, metaclass=AppStoreServerLibraryEnumMeta):
     """
-    A notification type value that App Store Server Notifications V2 uses.
+    The type that describes the in-app purchase or external purchase event for which the App Store sends the version 2 notification.
     
     https://developer.apple.com/documentation/appstoreservernotifications/notificationtype
     """

appstoreserverlibrary/models/RefundPreference.py

@@ -0,0 +1,16 @@
+# Copyright (c) 2024 Apple Inc. Licensed under MIT License.
+
+from enum import IntEnum
+
+from .LibraryUtility import AppStoreServerLibraryEnumMeta
+
+class RefundPreference(IntEnum, metaclass=AppStoreServerLibraryEnumMeta):
+    """
+    A value that indicates your preferred outcome for the refund request.
+    
+    https://developer.apple.com/documentation/appstoreserverapi/refundpreference
+    """
+    UNDECLARED = 0
+    PREFER_GRANT = 1
+    PREFER_DECLINE = 2
+    NO_PREFERENCE = 3

appstoreserverlibrary/models/Subtype.py

@@ -6,7 +6,7 @@
 
 class Subtype(str, Enum, metaclass=AppStoreServerLibraryEnumMeta):
     """
-    A notification subtype value that App Store Server Notifications V2 uses.
+    A string that provides details about select notification types in version 2.
     
     https://developer.apple.com/documentation/appstoreservernotifications/subtype
     """

tests/resources/models/signedConsumptionRequestNotification.json

@@ -0,0 +1,16 @@
+{
+    "notificationType": "CONSUMPTION_REQUEST",
+    "notificationUUID": "002e14d5-51f5-4503-b5a8-c3a1af68eb20",
+    "data": {
+      "environment": "LocalTesting",
+      "appAppleId": 41234,
+      "bundleId": "com.example",
+      "bundleVersion": "1.2.3",
+      "signedTransactionInfo": "signed_transaction_info_value",
+      "signedRenewalInfo": "signed_renewal_info_value",
+      "status": 1,
+      "consumptionRequestReason": "UNINTENDED_PURCHASE"
+    },
+    "version": "2.0",
+    "signedDate": 1698148900000
+}

tests/test_api_client.py

@@ -27,6 +27,7 @@
 from appstoreserverlibrary.models.Platform import Platform
 from appstoreserverlibrary.models.PlayTime import PlayTime
 from appstoreserverlibrary.models.PriceIncreaseStatus import PriceIncreaseStatus
+from appstoreserverlibrary.models.RefundPreference import RefundPreference
 from appstoreserverlibrary.models.RevocationReason import RevocationReason
 from appstoreserverlibrary.models.SendAttemptItem import SendAttemptItem
 from appstoreserverlibrary.models.SendAttemptResult import SendAttemptResult
@@ -309,7 +310,8 @@ def test_send_consumption_data(self):
                                             'playTime': 5,
                                             'lifetimeDollarsRefunded': 6,
                                             'lifetimeDollarsPurchased': 7,
-                                            'userStatus': 4})
+                                            'userStatus': 4,
+                                            'refundPreference': 3})
 
         consumptionRequest = ConsumptionRequest(
             customerConsented=True,
@@ -322,7 +324,8 @@ def test_send_consumption_data(self):
             playTime=PlayTime.ONE_DAY_TO_FOUR_DAYS,
             lifetimeDollarsRefunded=LifetimeDollarsRefunded.ONE_THOUSAND_DOLLARS_TO_ONE_THOUSAND_NINE_HUNDRED_NINETY_NINE_DOLLARS_AND_NINETY_NINE_CENTS,
             lifetimeDollarsPurchased=LifetimeDollarsPurchased.TWO_THOUSAND_DOLLARS_OR_GREATER,
-            userStatus=UserStatus.LIMITED_ACCESS
+            userStatus=UserStatus.LIMITED_ACCESS,
+            refundPreference=RefundPreference.NO_PREFERENCE
         )
 
         client.send_consumption_data('49571273', consumptionRequest)

tests/test_decoded_payloads.py

@@ -3,6 +3,7 @@
 from typing import Optional
 import unittest
 from appstoreserverlibrary.models.AutoRenewStatus import AutoRenewStatus
+from appstoreserverlibrary.models.ConsumptionRequestReason import ConsumptionRequestReason
 from appstoreserverlibrary.models.Environment import Environment
 from appstoreserverlibrary.models.ExpirationIntent import ExpirationIntent
 from appstoreserverlibrary.models.InAppOwnershipType import InAppOwnershipType
@@ -133,6 +134,37 @@ def test_notification_decoding(self):
         self.assertEqual("signed_renewal_info_value", notification.data.signedRenewalInfo);
         self.assertEqual(Status.ACTIVE, notification.data.status)
         self.assertEqual(1, notification.data.rawStatus)
+        self.assertIsNone(notification.data.consumptionRequestReason)
+        self.assertIsNone(notification.data.rawConsumptionRequestReason)
+
+    def test_consumption_request_notification_decoding(self):
+        signed_notification = create_signed_data_from_json('tests/resources/models/signedConsumptionRequestNotification.json')
+        
+        signed_data_verifier = get_default_signed_data_verifier()
+
+        notification = signed_data_verifier.verify_and_decode_notification(signed_notification)
+
+        self.assertEqual(NotificationTypeV2.CONSUMPTION_REQUEST, notification.notificationType)
+        self.assertEqual("CONSUMPTION_REQUEST", notification.rawNotificationType)
+        self.assertIsNone(notification.subtype)
+        self.assertIsNone(notification.rawSubtype)
+        self.assertEqual("002e14d5-51f5-4503-b5a8-c3a1af68eb20", notification.notificationUUID)
+        self.assertEqual("2.0", notification.version)
+        self.assertEqual(1698148900000, notification.signedDate)
+        self.assertIsNotNone(notification.data)
+        self.assertIsNone(notification.summary)
+        self.assertIsNone(notification.externalPurchaseToken)
+        self.assertEqual(Environment.LOCAL_TESTING, notification.data.environment)
+        self.assertEqual("LocalTesting", notification.data.rawEnvironment)
+        self.assertEqual(41234, notification.data.appAppleId)
+        self.assertEqual("com.example", notification.data.bundleId)
+        self.assertEqual("1.2.3", notification.data.bundleVersion)
+        self.assertEqual("signed_transaction_info_value", notification.data.signedTransactionInfo)
+        self.assertEqual("signed_renewal_info_value", notification.data.signedRenewalInfo);
+        self.assertEqual(Status.ACTIVE, notification.data.status)
+        self.assertEqual(1, notification.data.rawStatus)
+        self.assertEqual(ConsumptionRequestReason.UNINTENDED_PURCHASE, notification.data.consumptionRequestReason)
+        self.assertEqual("UNINTENDED_PURCHASE", notification.data.rawConsumptionRequestReason)
 
     def test_summary_notification_decoding(self):
         signed_summary_notification = create_signed_data_from_json('tests/resources/models/signedSummaryNotification.json')