feat: Add support for App Store Server API v1.15 (#63)

Author: caobug

assets/appTransaction.json

@@ -9,5 +9,7 @@
   "originalApplicationVersion": "1.1.2",
   "deviceVerification": "device_verification_value",
   "deviceVerificationNonce": "48ccfa42-7431-4f22-9908-7e88983e105a",
-  "preorderDate": 1698148700000
+  "preorderDate": 1698148700000,
+  "appTransactionId": "71134",
+  "originalPlatform": "iOS"
 }

assets/signedRenewalInfo.json

@@ -19,5 +19,8 @@
   "eligibleWinBackOfferIds": [
     "eligible1",
     "eligible2"
-  ]
+  ],
+  "appTransactionId": "71134",
+  "offerPeriod": "P1Y",
+  "appAccountToken": "7e3fb20b-4cdb-47cc-936d-99d65f608138"
 }

assets/signedTransaction.json

@@ -24,5 +24,7 @@
   "storefrontId":"143441",
   "price": 10990,
   "currency": "USD",
-  "offerDiscountType": "PAY_AS_YOU_GO"
+  "offerDiscountType": "PAY_AS_YOU_GO",
+  "appTransactionId": "71134",
+  "offerPeriod": "P1Y"
 }

src/primitives/app_transaction.rs

@@ -1,4 +1,5 @@
 use crate::primitives::environment::Environment;
+use crate::primitives::purchase_platform::PurchasePlatform;
 use chrono::{DateTime, Utc};
 use serde::{Deserialize, Serialize};
 use serde_with::formats::Flexible;
@@ -68,6 +69,18 @@ pub struct AppTransaction {
     #[serde(rename = "preorderDate")]
     #[serde_as(as = "Option<TimestampMilliSeconds<String, Flexible>>")]
     pub preorder_date: Option<DateTime<Utc>>,
+
+    /// The unique identifier of the app download transaction.
+    ///
+    /// [appTransactionId](https://developer.apple.com/documentation/storekit/apptransaction/apptransactionid)
+    #[serde(rename = "appTransactionId")]
+    pub app_transaction_id: Option<String>,
+
+    /// The platform on which the customer originally purchased the app.
+    ///
+    /// [original_platform](https://developer.apple.com/documentation/storekit/apptransaction/originalplatform)
+    #[serde(rename = "originalPlatform")]
+    pub original_platform: Option<PurchasePlatform>,
 }
 
 impl AppTransaction {

src/primitives/error_payload.rs

@@ -167,6 +167,11 @@ pub enum APIError {
     /// [InvalidTransactionTypeNotSupportedError](https://developer.apple.com/documentation/appstoreserverapi/invalidtransactiontypenotsupportederror)
     InvalidTransactionTypeNotSupported = 4000047,
 
+    /// An error that indicates the endpoint doesn't support an app transaction ID.
+    ///
+    /// [AppTransactionIdNotSupportedError](https://developer.apple.com/documentation/appstoreserverapi/apptransactionidnotsupportederror)
+    AppTransactionIdNotSupportedError = 4000048,
+
     /// An error that indicates the subscription doesn't qualify for a renewal-date extension due to its subscription state.
     /// [Documentation](https://developer.apple.com/documentation/appstoreserverapi/subscriptionextensionineligibleerror)
     SubscriptionExtensionIneligible = 4030004,

src/primitives/jws_renewal_info_decoded_payload.rs

@@ -7,6 +7,7 @@ use chrono::{DateTime, Utc};
 use serde::{Deserialize, Serialize};
 use serde_with::formats::Flexible;
 use serde_with::TimestampMilliSeconds;
+use uuid::Uuid;
 use crate::primitives::offer_discount_type::OfferDiscountType;
 
 /// A decoded payload containing subscription renewal information for an auto-renewable subscription.
@@ -124,5 +125,23 @@ pub struct JWSRenewalInfoDecodedPayload {
     ///
     ///[eligibleWinBackOfferIds](https://developer.apple.com/documentation/appstoreserverapi/eligiblewinbackofferids)
     #[serde(rename = "eligibleWinBackOfferIds")]
-    pub eligible_win_back_offer_ids: Option<Vec<String>>
+    pub eligible_win_back_offer_ids: Option<Vec<String>>,
+
+    /// The UUID that an app optionally generates to map a customer’s in-app purchase with its resulting App Store transaction.
+    ///
+    /// [appAccountToken](https://developer.apple.com/documentation/appstoreserverapi/appAccountToken)
+    #[serde(rename = "appAccountToken")]
+    pub app_account_token: Option<Uuid>,
+
+    /// The unique identifier of the app download transaction.
+    ///
+    /// [appTransactionId](https://developer.apple.com/documentation/appstoreserverapi/appTransactionId)
+    #[serde(rename = "appTransactionId")]
+    pub app_transaction_id: Option<String>,
+
+    /// The duration of the offer.
+    ///
+    /// [offerPeriod](https://developer.apple.com/documentation/appstoreserverapi/offerPeriod)
+    #[serde(rename = "offerPeriod")]
+    pub offer_period: Option<String>,
 }

src/primitives/jws_transaction_decoded_payload.rs

@@ -172,4 +172,16 @@ pub struct JWSTransactionDecodedPayload {
     /// [offerDiscountType](https://developer.apple.com/documentation/appstoreserverapi/offerdiscounttype)
     #[serde(rename = "offerDiscountType")]
     pub offer_discount_type: Option<OfferDiscountType>,
+
+    /// The unique identifier of the app download transaction.
+    ///
+    /// [appTransactionId](https://developer.apple.com/documentation/appstoreserverapi/appTransactionId)
+    #[serde(rename = "appTransactionId")]
+    pub app_transaction_id: Option<String>,
+
+    /// The duration of the offer.
+    ///
+    /// [offerPeriod](https://developer.apple.com/documentation/appstoreserverapi/offerPeriod)
+    #[serde(rename = "offerPeriod")]
+    pub offer_period: Option<String>,
 }

src/primitives/mod.rs

@@ -54,3 +54,4 @@ pub mod user_status;
 pub mod external_purchase_token;
 pub mod consumption_request_reason;
 pub mod refund_preference;
+pub mod purchase_platform;

src/primitives/purchase_platform.rs

@@ -0,0 +1,18 @@
+use serde::{Deserialize, Serialize};
+
+/// Values that represent Apple platforms.
+///
+/// [PurchasePlatform](https://developer.apple.com/documentation/storekit/appstore/platform)
+#[derive(Debug, Clone, Deserialize, Serialize, Hash, PartialEq, Eq)]
+pub enum PurchasePlatform {
+    #[serde(rename = "iOS")]
+    IOS,
+    #[serde(rename = "macOS")]
+    MacOs,
+    #[serde(rename = "tvOS")]
+    TvOs,
+    #[serde(rename = "visionOS")]
+    VisionOs,
+    #[serde(rename = "watchOS")]
+    WatchOs,
+}

src/signed_data_verifier.rs

@@ -311,6 +311,7 @@ mod tests {
     use crate::primitives::offer_type::OfferType;
     use crate::primitives::price_increase_status::PriceIncreaseStatus;
     use crate::primitives::product_type::ProductType;
+    use crate::primitives::purchase_platform::PurchasePlatform;
     use crate::primitives::revocation_reason::RevocationReason;
     use crate::primitives::status::Status;
     use crate::primitives::subtype::Subtype;
@@ -595,6 +596,19 @@ mod tests {
                         .expect("Expect preorder_date")
                         .timestamp()
                 );
+                assert_eq!(
+                    "71134",
+                    app_transaction
+                        .app_transaction_id
+                        .expect("Expect app_transaction_id")
+                        .to_string()
+                );
+                assert_eq!(
+                    PurchasePlatform::IOS,
+                    app_transaction
+                        .original_platform
+                        .expect("Expect original_platform")
+                );
             }
             Err(err) => panic!("Failed to verify and decode app transaction: {:?}", err),
         }
@@ -753,6 +767,20 @@ mod tests {
                         .offer_discount_type
                         .expect("Expect offer_discount_type")
                 );
+                assert_eq!(
+                    "71134",
+                    transaction
+                        .app_transaction_id
+                        .expect("Expect app_transaction_id")
+                        .to_string()
+                );
+                assert_eq!(
+                    "P1Y",
+                    transaction
+                        .offer_period
+                        .expect("Expect offer_period")
+                        .to_string()
+                );
             }
             Err(err) => panic!("Failed to verify and decode signed transaction: {:?}", err),
         }
@@ -849,6 +877,27 @@ mod tests {
                         .expect("Expect renewal_date")
                         .timestamp()
                 );
+                assert_eq!(
+                    "71134",
+                    renewal_info
+                        .app_transaction_id
+                        .expect("Expect app_transaction_id")
+                        .to_string()
+                );
+                assert_eq!(
+                    "P1Y",
+                    renewal_info
+                        .offer_period
+                        .expect("Expect offer_period")
+                        .to_string()
+                );
+                assert_eq!(
+                    "7e3fb20b-4cdb-47cc-936d-99d65f608138",
+                    renewal_info
+                        .app_account_token
+                        .expect("Expect app_account_token")
+                        .to_string()
+                );
             }
             Err(err) => panic!("Failed to verify and decode renewal info: {:?}", err),
         }