Skip to content

Updating AppTransaction documentation #179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexanderjordanbaker merged 1 commit into from
Mar 11, 2026
Merged

Updating AppTransaction documentation #179

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 20 additions & 19 deletions appstoreserverlibrary/models/AppTransaction.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,17 @@
@define
class AppTransaction(AttrsRawValueAware):
"""
Information that represents the customer’s purchase of the app, cryptographically signed by the App Store.
A decoded payload that contains app transaction information.

https://developer.apple.com/documentation/storekit/apptransaction
https://developer.apple.com/documentation/appstoreserverapi/jwsapptransactiondecodedpayload
"""

receiptType: Optional[Environment] = Environment.create_main_attr('rawReceiptType')
"""
The server environment that signs the app transaction.
https://developer.apple.com/documentation/storekit/apptransaction/3963901-environment
The date that the App Store signed the JWS app transaction.

https://developer.apple.com/documentation/appstoreserverapi/environment
"""

rawReceiptType: Optional[str] = Environment.create_raw_attr('receiptType')
Expand All @@ -33,84 +34,84 @@ class AppTransaction(AttrsRawValueAware):
"""
The unique identifier the App Store uses to identify the app.

https://developer.apple.com/documentation/storekit/apptransaction/3954436-appid
https://developer.apple.com/documentation/appstoreserverapi/appappleid
"""

bundleId: Optional[str] = attr.ib(default=None)
"""
The bundle identifier that the app transaction applies to.

https://developer.apple.com/documentation/storekit/apptransaction/3954439-bundleid
https://developer.apple.com/documentation/appstoreserverapi/bundleid
"""

applicationVersion: Optional[str] = attr.ib(default=None)
"""
The app version that the app transaction applies to.

https://developer.apple.com/documentation/storekit/apptransaction/3954437-appversion
https://developer.apple.com/documentation/storekit/apptransaction/appversion
"""

versionExternalIdentifier: Optional[int] = attr.ib(default=None)
"""
The version external identifier of the app

https://developer.apple.com/documentation/storekit/apptransaction/3954438-appversionid
https://developer.apple.com/documentation/storekit/apptransaction/appversionid
"""

receiptCreationDate: Optional[int] = attr.ib(default=None)
"""
The date that the App Store signed the JWS app transaction.

https://developer.apple.com/documentation/storekit/apptransaction/3954449-signeddate
https://developer.apple.com/documentation/appstoreserverapi/receiptcreationdate
"""

originalPurchaseDate: Optional[int] = attr.ib(default=None)
"""
The date the user originally purchased the app from the App Store.
https://developer.apple.com/documentation/storekit/apptransaction/3954448-originalpurchasedate
The date the customer originally purchased the app from the App Store.

https://developer.apple.com/documentation/appstoreserverapi/originalpurchasedate
"""

originalApplicationVersion: Optional[str] = attr.ib(default=None)
"""
The app version that the user originally purchased from the App Store.

https://developer.apple.com/documentation/storekit/apptransaction/3954447-originalappversion
https://developer.apple.com/documentation/appstoreserverapi/originalapplicationversion
"""

deviceVerification: Optional[str] = attr.ib(default=None)
"""
The Base64 device verification value to use to verify whether the app transaction belongs to the device.

https://developer.apple.com/documentation/storekit/apptransaction/3954441-deviceverification
https://developer.apple.com/documentation/storekit/apptransaction/deviceverification
"""

deviceVerificationNonce: Optional[str] = attr.ib(default=None)
"""
The UUID used to compute the device verification value.

https://developer.apple.com/documentation/storekit/apptransaction/3954442-deviceverificationnonce
https://developer.apple.com/documentation/storekit/apptransaction/deviceverificationnonce
"""

preorderDate: Optional[int] = attr.ib(default=None)
"""
The date the customer placed an order for the app before it's available in the App Store.

https://developer.apple.com/documentation/storekit/apptransaction/4013175-preorderdate
https://developer.apple.com/documentation/appstoreserverapi/preorderdate
"""

appTransactionId: Optional[str] = attr.ib(default=None)
"""
The unique identifier of the app download transaction.

https://developer.apple.com/documentation/storekit/apptransaction/apptransactionid
https://developer.apple.com/documentation/appstoreserverapi/apptransactionid
"""

originalPlatform: Optional[PurchasePlatform] = PurchasePlatform.create_main_attr('rawOriginalPlatform')
"""
The platform on which the customer originally purchased the app.

https://developer.apple.com/documentation/storekit/apptransaction/originalplatform-4mogz
https://developer.apple.com/documentation/appstoreserverapi/originalplatform
"""

rawOriginalPlatform: Optional[str] = PurchasePlatform.create_raw_attr('originalPlatform')
Expand Down