Merge pull request #160 from alexanderjordanbaker/RetentionMessaging1.1

Add support for the Retention Messaging API 1.0-1.1 https://developer…

Author: alexanderjordanbaker

README.md

@@ -1,5 +1,5 @@
 # Apple App Store Server Python Library
-The [Python](https://github.com/apple/app-store-server-library-python) server library for the [App Store Server API](https://developer.apple.com/documentation/appstoreserverapi) and [App Store Server Notifications](https://developer.apple.com/documentation/appstoreservernotifications). Also available in [Swift](https://github.com/apple/app-store-server-library-swift), [Node.js](https://github.com/apple/app-store-server-library-node), and [Java](https://github.com/apple/app-store-server-library-java).
+The [Python](https://github.com/apple/app-store-server-library-python) server library for the [App Store Server API](https://developer.apple.com/documentation/appstoreserverapi), [App Store Server Notifications](https://developer.apple.com/documentation/appstoreservernotifications), and [Retention Messaging API](https://developer.apple.com/documentation/retentionmessaging). Also available in [Swift](https://github.com/apple/app-store-server-library-swift), [Node.js](https://github.com/apple/app-store-server-library-node), and [Java](https://github.com/apple/app-store-server-library-java).
 
 ## Table of Contents
 1. [Installation](#installation)

appstoreserverlibrary/api_client.py

@@ -0,0 +1,28 @@
+# Copyright (c) 2025 Apple Inc. Licensed under MIT License.
+from typing import Optional
+from uuid import UUID
+
+from attr import define
+import attr
+
+@define
+class AlternateProduct:
+    """
+    A switch-plan message and product ID you provide in a real-time response to your Get Retention Message endpoint.
+
+    https://developer.apple.com/documentation/retentionmessaging/alternateproduct
+    """
+
+    messageIdentifier: Optional[UUID] = attr.ib(default=None)
+    """
+    The message identifier of the text to display in the switch-plan retention message.
+
+    https://developer.apple.com/documentation/retentionmessaging/messageidentifier
+    """
+
+    productId: Optional[str] = attr.ib(default=None)
+    """
+    The product identifier of the subscription the retention message suggests for your customer to switch to.
+
+    https://developer.apple.com/documentation/retentionmessaging/productid
+    """

appstoreserverlibrary/models/AlternateProduct.py

@@ -0,0 +1,73 @@
+# Copyright (c) 2025 Apple Inc. Licensed under MIT License.
+
+from typing import Optional
+from uuid import UUID
+
+from attr import define
+import attr
+
+from .Environment import Environment
+from .LibraryUtility import AttrsRawValueAware
+
+@define
+class DecodedRealtimeRequestBody(AttrsRawValueAware):
+    """
+    The decoded request body the App Store sends to your server to request a real-time retention message.
+
+    https://developer.apple.com/documentation/retentionmessaging/decodedrealtimerequestbody
+    """
+
+    originalTransactionId: str = attr.ib()
+    """
+    The original transaction identifier of the customer's subscription.
+
+    https://developer.apple.com/documentation/retentionmessaging/originaltransactionid
+    """
+
+    appAppleId: int = attr.ib()
+    """
+    The unique identifier of the app in the App Store.
+
+    https://developer.apple.com/documentation/retentionmessaging/appappleid
+    """
+
+    productId: str = attr.ib()
+    """
+    The unique identifier of the auto-renewable subscription.
+
+    https://developer.apple.com/documentation/retentionmessaging/productid
+    """
+
+    userLocale: str = attr.ib()
+    """
+    The device's locale.
+
+    https://developer.apple.com/documentation/retentionmessaging/locale
+    """
+
+    requestIdentifier: UUID = attr.ib()
+    """
+    A UUID the App Store server creates to uniquely identify each request.
+
+    https://developer.apple.com/documentation/retentionmessaging/requestidentifier
+    """
+
+    signedDate: int = attr.ib()
+    """
+    The UNIX time, in milliseconds, that the App Store signed the JSON Web Signature (JWS) data.
+
+    https://developer.apple.com/documentation/retentionmessaging/signeddate
+    """
+
+    environment: Optional[Environment] = Environment.create_main_attr('rawEnvironment', raw_required=True)
+    """
+    The server environment, either sandbox or production.
+
+    https://developer.apple.com/documentation/retentionmessaging/environment
+    """
+
+    rawEnvironment: str = Environment.create_raw_attr('environment', required=True)
+    """
+    See environment
+    """
+

appstoreserverlibrary/models/DecodedRealtimeRequestBody.py

@@ -0,0 +1,22 @@
+# Copyright (c) 2025 Apple Inc. Licensed under MIT License.
+
+from typing import Optional
+from uuid import UUID
+
+from attr import define
+import attr
+
+@define
+class DefaultConfigurationRequest:
+    """
+    The request body that contains the default configuration information.
+
+    https://developer.apple.com/documentation/retentionmessaging/defaultconfigurationrequest
+    """
+
+    messageIdentifier: Optional[UUID] = attr.ib(default=None)
+    """
+    The message identifier of the message to configure as a default message.
+
+    https://developer.apple.com/documentation/retentionmessaging/messageidentifier
+    """

appstoreserverlibrary/models/DefaultConfigurationRequest.py

@@ -0,0 +1,23 @@
+# Copyright (c) 2025 Apple Inc. Licensed under MIT License.
+
+from typing import Optional, List
+
+from attr import define
+import attr
+
+from .GetImageListResponseItem import GetImageListResponseItem
+
+@define
+class GetImageListResponse:
+    """
+    A response that contains status information for all images.
+
+    https://developer.apple.com/documentation/retentionmessaging/getimagelistresponse
+    """
+
+    imageIdentifiers: Optional[List[GetImageListResponseItem]] = attr.ib(default=None)
+    """
+    An array of all image identifiers and their image state.
+
+    https://developer.apple.com/documentation/retentionmessaging/getimagelistresponseitem
+    """

appstoreserverlibrary/models/GetImageListResponse.py

@@ -0,0 +1,37 @@
+# Copyright (c) 2025 Apple Inc. Licensed under MIT License.
+
+from typing import Optional
+from uuid import UUID
+
+from attr import define
+import attr
+
+from .ImageState import ImageState
+from .LibraryUtility import AttrsRawValueAware
+
+@define
+class GetImageListResponseItem(AttrsRawValueAware):
+    """
+    An image identifier and state information for an image.
+
+    https://developer.apple.com/documentation/retentionmessaging/getimagelistresponseitem
+    """
+
+    imageIdentifier: Optional[UUID] = attr.ib(default=None)
+    """
+    The identifier of the image.
+
+    https://developer.apple.com/documentation/retentionmessaging/imageidentifier
+    """
+
+    imageState: Optional[ImageState] = ImageState.create_main_attr('rawImageState')
+    """
+    The current state of the image.
+
+    https://developer.apple.com/documentation/retentionmessaging/imagestate
+    """
+
+    rawImageState: Optional[str] = ImageState.create_raw_attr('imageState')
+    """
+    See imageState
+    """

appstoreserverlibrary/models/GetImageListResponseItem.py

@@ -0,0 +1,23 @@
+# Copyright (c) 2025 Apple Inc. Licensed under MIT License.
+
+from typing import Optional, List
+
+from attr import define
+import attr
+
+from .GetMessageListResponseItem import GetMessageListResponseItem
+
+@define
+class GetMessageListResponse:
+    """
+    A response that contains status information for all messages.
+
+    https://developer.apple.com/documentation/retentionmessaging/getmessagelistresponse
+    """
+
+    messageIdentifiers: Optional[List[GetMessageListResponseItem]] = attr.ib(default=None)
+    """
+    An array of all message identifiers and their message state.
+
+    https://developer.apple.com/documentation/retentionmessaging/getmessagelistresponseitem
+    """

appstoreserverlibrary/models/GetMessageListResponse.py

@@ -0,0 +1,37 @@
+# Copyright (c) 2025 Apple Inc. Licensed under MIT License.
+
+from typing import Optional
+from uuid import UUID
+
+from attr import define
+import attr
+
+from .MessageState import MessageState
+from .LibraryUtility import AttrsRawValueAware
+
+@define
+class GetMessageListResponseItem(AttrsRawValueAware):
+    """
+    A message identifier and status information for a message.
+
+    https://developer.apple.com/documentation/retentionmessaging/getmessagelistresponseitem
+    """
+
+    messageIdentifier: Optional[UUID] = attr.ib(default=None)
+    """
+    The identifier of the message.
+
+    https://developer.apple.com/documentation/retentionmessaging/messageidentifier
+    """
+
+    messageState: Optional[MessageState] = MessageState.create_main_attr('rawMessageState')
+    """
+    The current state of the message.
+
+    https://developer.apple.com/documentation/retentionmessaging/messageState
+    """
+
+    rawMessageState: Optional[str] = MessageState.create_raw_attr('messageState')
+    """
+    See messageState
+    """

appstoreserverlibrary/models/GetMessageListResponseItem.py

@@ -0,0 +1,15 @@
+# Copyright (c) 2025 Apple Inc. Licensed under MIT License.
+
+from enum import Enum
+
+from .LibraryUtility import AppStoreServerLibraryEnumMeta
+
+class ImageState(str, Enum, metaclass=AppStoreServerLibraryEnumMeta):
+    """
+    The approval state of an image.
+
+    https://developer.apple.com/documentation/retentionmessaging/imagestate
+    """
+    PENDING = "PENDING"
+    APPROVED = "APPROVED"
+    REJECTED = "REJECTED"