Merge pull request #89 from riyazpanjwani/main

Add support for Set App Account Token endpoint

Author: riyazpanjwani

Sources/AppStoreServerLibrary/AppStoreServerAPIClient.swift

@@ -325,6 +325,16 @@ public class AppStoreServerAPIClient {
     public func sendConsumptionData(transactionId: String, consumptionRequest: ConsumptionRequest) async -> APIResult<Void> {
         return await makeRequestWithoutResponseBody(path: "/inApps/v1/transactions/consumption/" + transactionId, method: .PUT, queryParameters: [:], body: consumptionRequest)
     }
+
+    ///Sets the app account token value for a purchase the customer makes outside your app, or updates its value in an existing transaction.
+    ///
+    ///- Parameter originalTransactionId: The original transaction identifier of the transaction to receive the app account token update.
+    ///- Parameter updateAppAccountTokenRequest :  The request body that contains a valid app account token value.
+    ///- Returns: Success, or information about the failure
+    ///[Set App Account Token](https://developer.apple.com/documentation/appstoreserverapi/set-app-account-token)
+    public func setAppAccountToken(originalTransactionId: String, updateAppAccountTokenRequest: UpdateAppAccountTokenRequest) async -> APIResult<Void> {
+        return await makeRequestWithoutResponseBody(path: "/inApps/v1/transactions/" + originalTransactionId + "/appAccountToken", method: .PUT, queryParameters: [:], body: updateAppAccountTokenRequest)
+    }
 
     internal struct AppStoreServerAPIJWT: JWTPayload, Equatable {
         var exp: ExpirationClaim
@@ -552,6 +562,21 @@ public enum APIError: Int64 {
     ///[AppTransactionIdNotSupportedError](https://developer.apple.com/documentation/appstoreserverapi/apptransactionidnotsupportederror)
     case appTransactionIdNotSupported = 4000048
 
+    ///An error that indicates the app account token value is not a valid UUID.
+    ///
+    ///[InvalidAppAccountTokenUUIDError](https://developer.apple.com/documentation/appstoreserverapi/invalidappaccounttokenuuiderror)
+    case invalidAppAccountTokenUUID = 4000183
+
+    ///An error that indicates the transaction is for a product the customer obtains through Family Sharing, which the endpoint doesn’t support.
+    ///
+    ///[FamilyTransactionNotSupportedError](https://developer.apple.com/documentation/appstoreserverapi/familytransactionnotsupportederror)
+    case familyTransactionNotSupported = 4000185
+
+    ///An error that indicates the endpoint expects an original transaction identifier.
+    ///
+    ///[TransactionIdIsNotOriginalTransactionIdError](https://developer.apple.com/documentation/appstoreserverapi/transactionidisnotoriginaltransactioniderror)
+    case transactionIdNotOriginalTransactionId = 4000187
+
     ///An error that indicates the subscription doesn't qualify for a renewal-date extension due to its subscription state.
     ///
     ///[SubscriptionExtensionIneligibleError](https://developer.apple.com/documentation/appstoreserverapi/subscriptionextensionineligibleerror)

Sources/AppStoreServerLibrary/Models/UpdateAppAccountTokenRequest.swift

@@ -0,0 +1,31 @@
+// Copyright (c) 2025 Apple Inc. Licensed under MIT License.
+
+import Foundation
+
+///The request body that contains an app account token value.
+///
+///[UpdateAppAccountTokenRequest](https://developer.apple.com/documentation/appstoreserverapi/updateappaccounttokenrequest)
+public struct UpdateAppAccountTokenRequest: Decodable, Encodable, Hashable, Sendable  {
+    ///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)
+    public let appAccountToken: UUID
+
+    public init(appAccountToken: UUID) {
+        self.appAccountToken = appAccountToken
+    }
+
+    public enum CodingKeys: CodingKey {
+        case appAccountToken
+    }
+
+    public init (from decoder: any Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        self.appAccountToken = try container.decode(UUID.self, forKey: .appAccountToken)
+    }
+
+    public func encode(to encoder: any Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encode(self.appAccountToken, forKey: .appAccountToken)
+    }
+}

Tests/AppStoreServerLibraryTests/AppStoreServerAPIClientTests.swift

@@ -634,6 +634,82 @@ final class AppStoreServerAPIClientTests: XCTestCase {
             XCTAssertEqual(AppStoreServerAPIClient.ConfigurationError.invalidEnvironment, e as! AppStoreServerAPIClient.ConfigurationError)
         }
     }
+
+    public func testSetAppAccountToken() async throws {
+        let client = try getAppStoreServerAPIClient("") { request, body in
+            XCTAssertEqual(.PUT, request.method)
+            XCTAssertEqual("https://local-testing-base-url/inApps/v1/transactions/49571273/appAccountToken", request.url)
+            XCTAssertEqual(["application/json"], request.headers["Content-Type"])
+            let decodedJson = try! JSONSerialization.jsonObject(with: body!) as! [String: Any]
+            XCTAssertEqual("7389A31A-FB6D-4569-A2A6-DB7D85D84813", decodedJson["appAccountToken"] as! String)
+        }
+        
+        let updateAppAccountTokenRequest = UpdateAppAccountTokenRequest(
+            appAccountToken: UUID(uuidString: "7389a31a-fb6d-4569-a2a6-db7d85d84813")!
+        )
+        TestingUtility.confirmCodableInternallyConsistent(updateAppAccountTokenRequest)
+        
+        let response = await client.setAppAccountToken(originalTransactionId: "49571273", updateAppAccountTokenRequest: updateAppAccountTokenRequest)
+        guard case .success(_) = response else {
+            XCTAssertTrue(false)
+            return
+        }
+    }
+
+
+    public func testInvalidAppAccountTokenUUIDError() async throws {
+        let body = TestingUtility.readFile("resources/models/invalidAppAccountTokenUUIDError.json")
+        let client = try getAppStoreServerAPIClient(body, .badRequest, nil)
+        let updateAppAccountTokenRequest = UpdateAppAccountTokenRequest(
+            appAccountToken: UUID(uuidString: "7389a31a-fb6d-4569-a2a6-db7d85d84813")!
+        )
+        let result = await client.setAppAccountToken(originalTransactionId: "1234", updateAppAccountTokenRequest: updateAppAccountTokenRequest)
+        guard case .failure(let statusCode, let rawApiError, let apiError, let errorMessage, let causedBy) = result else {
+            XCTAssertTrue(false)
+            return
+        }
+        XCTAssertEqual(400, statusCode)
+        XCTAssertNotNil(apiError)
+        XCTAssertEqual(4000183, rawApiError)
+        XCTAssertEqual("Invalid request. The app account token field must be a valid UUID.", errorMessage)
+        XCTAssertNil(causedBy)
+    }
+
+    public func testFamilySharedTransactionNotSupportedError() async throws {
+        let body = TestingUtility.readFile("resources/models/familyTransactionNotSupportedError.json")
+        let client = try getAppStoreServerAPIClient(body, .badRequest, nil)
+        let updateAppAccountTokenRequest = UpdateAppAccountTokenRequest(
+            appAccountToken: UUID(uuidString: "7389a31a-fb6d-4569-a2a6-db7d85d84813")!
+        )
+        let result = await client.setAppAccountToken(originalTransactionId: "1234", updateAppAccountTokenRequest: updateAppAccountTokenRequest)
+        guard case .failure(let statusCode, let rawApiError, let apiError, let errorMessage, let causedBy) = result else {
+            XCTAssertTrue(false)
+            return
+        }
+        XCTAssertEqual(400, statusCode)
+        XCTAssertNotNil(apiError)
+        XCTAssertEqual(4000185, rawApiError)
+        XCTAssertEqual("Invalid request. Family Sharing transactions aren't supported by this endpoint.", errorMessage)
+        XCTAssertNil(causedBy)
+    }
+
+    public func testTransactionIdNotOriginalTransactionIdError() async throws {
+        let body = TestingUtility.readFile("resources/models/transactionIdNotOriginalTransactionId.json")
+        let client = try getAppStoreServerAPIClient(body, .badRequest, nil)
+        let updateAppAccountTokenRequest = UpdateAppAccountTokenRequest(
+            appAccountToken: UUID(uuidString: "7389a31a-fb6d-4569-a2a6-db7d85d84813")!
+        )
+        let result = await client.setAppAccountToken(originalTransactionId: "1234", updateAppAccountTokenRequest: updateAppAccountTokenRequest)
+        guard case .failure(let statusCode, let rawApiError, let apiError, let errorMessage, let causedBy) = result else {
+            XCTAssertTrue(false)
+            return
+        }
+        XCTAssertEqual(400, statusCode)
+        XCTAssertNotNil(apiError)
+        XCTAssertEqual(4000187, rawApiError)
+        XCTAssertEqual("Invalid request. The transaction ID provided is not an original transaction ID.", errorMessage)
+        XCTAssertNil(causedBy)
+    }
 
     public func getClientWithBody(_ path: String, _ requestVerifier: @escaping RequestVerifier) throws -> AppStoreServerAPIClient {
         let body = TestingUtility.readFile(path)

Tests/AppStoreServerLibraryTests/resources/models/familyTransactionNotSupportedError.json

@@ -0,0 +1,4 @@
+{
+  "errorCode": 4000185,
+  "errorMessage": "Invalid request. Family Sharing transactions aren't supported by this endpoint."
+}

Tests/AppStoreServerLibraryTests/resources/models/invalidAppAccountTokenUUIDError.json

@@ -0,0 +1,4 @@
+{
+  "errorCode": 4000183,
+  "errorMessage": "Invalid request. The app account token field must be a valid UUID."
+}

Tests/AppStoreServerLibraryTests/resources/models/transactionIdNotOriginalTransactionId.json

@@ -0,0 +1,4 @@
+{
+  "errorCode": 4000187,
+  "errorMessage": "Invalid request. The transaction ID provided is not an original transaction ID."
+}