Add Advanced Commerce objects

Author: Riyaz Panjwani

appstoreserverlibrary/models/AbstractAdvancedCommerceInAppRequest.py

@@ -0,0 +1,28 @@
+# Copyright (c) 2025 Apple Inc. Licensed under MIT License.
+
+from abc import ABC, abstractmethod
+from typing import Optional
+from attr import define
+import attr
+from .AdvancedCommerceRequest import AdvancedCommerceRequest
+from .AdvancedCommerceRequestInfo import AdvancedCommerceRequestInfo
+
+
+@define
+class AbstractAdvancedCommerceInAppRequest(AdvancedCommerceRequest, ABC):
+    """
+    Abstract base class for Advanced Commerce in-app requests.
+    """
+    
+    operation: str = attr.field()
+    version: str = attr.field()
+    
+    def __init__(self, operation: str, version: str, requestInfo: AdvancedCommerceRequestInfo):
+        super().__init__(requestInfo)
+        self.operation = operation
+        self.version = version
+    
+    @abstractmethod
+    def self(self):
+        """Return self for method chaining."""
+        pass

appstoreserverlibrary/models/AbstractAdvancedCommerceItem.py

@@ -0,0 +1,42 @@
+# Copyright (c) 2023 Apple Inc. Licensed under MIT License.
+
+from abc import ABC, abstractmethod
+from typing import Dict, Any, Optional
+from attr import define
+import attr
+
+
+@define
+class AbstractAdvancedCommerceItem(ABC):
+    """
+    Abstract base class for Advanced Commerce items.
+    """
+    
+    sku: str = attr.field()
+    description: str = attr.field()
+    displayName: str = attr.field()
+    unknownFields: Optional[Dict[str, Any]] = attr.field(default=None)
+    
+    MAXIMUM_DESCRIPTION_LENGTH = 45
+    MAXIMUM_DISPLAY_NAME_LENGTH = 30
+    MAXIMUM_SKU_LENGTH = 128
+    
+    @sku.validator
+    def _validate_sku(self, attribute, value):
+        if value is not None and len(value) > self.MAXIMUM_SKU_LENGTH:
+            raise ValueError("sku length longer than maximum allowed")
+    
+    @description.validator
+    def _validate_description(self, attribute, value):
+        if value is not None and len(value) > self.MAXIMUM_DESCRIPTION_LENGTH:
+            raise ValueError("description length longer than maximum allowed")
+    
+    @displayName.validator
+    def _validate_display_name(self, attribute, value):
+        if value is not None and len(value) > self.MAXIMUM_DISPLAY_NAME_LENGTH:
+            raise ValueError("displayName length longer than maximum allowed")
+    
+    @abstractmethod
+    def self(self):
+        """Return self for method chaining."""
+        pass

appstoreserverlibrary/models/AbstractAdvancedCommerceResponse.py

@@ -0,0 +1,15 @@
+# Copyright (c) 2025 Apple Inc. Licensed under MIT License.
+
+from typing import Optional
+from attr import define
+import attr
+
+
+@define
+class AbstractAdvancedCommerceResponse:
+    """
+    Abstract base class for Advanced Commerce responses.
+    """
+    
+    signedRenewalInfo: Optional[str] = attr.field(default=None)
+    signedTransactionInfo: Optional[str] = attr.field(default=None)

appstoreserverlibrary/models/AdvancedCommerceDescriptors.py

@@ -0,0 +1,42 @@
+# Copyright (c) 2025 Apple Inc. Licensed under MIT License.
+
+from typing import Dict, Any, Optional
+
+from attr import define
+import attr
+
+@define
+class AdvancedCommerceDescriptors:
+    """
+    The description and display name of the subscription to migrate to that you manage.
+    """
+    
+    # Maximum field lengths from Java implementation
+    MAXIMUM_DESCRIPTION_LENGTH = 45
+    MAXIMUM_DISPLAY_NAME_LENGTH = 30
+    
+    description: Optional[str] = attr.ib(default=None)
+    display_name: Optional[str] = attr.ib(default=None)
+    unknown_fields: Optional[Dict[str, Any]] = attr.ib(default=None)
+    
+    def __attrs_post_init__(self):
+        if self.description is not None:
+            self.description = self._validate_description(self.description)
+        if self.display_name is not None:
+            self.display_name = self._validate_display_name(self.display_name)
+    
+    def _validate_description(self, description: str) -> str:
+        """Validate description field."""
+        if description is None:
+            raise ValueError("Description cannot be None")
+        if len(description) > self.MAXIMUM_DESCRIPTION_LENGTH:
+            raise ValueError("Description length longer than maximum allowed")
+        return description
+    
+    def _validate_display_name(self, display_name: str) -> str:
+        """Validate display name field."""
+        if display_name is None:
+            raise ValueError("Display name cannot be None")
+        if len(display_name) > self.MAXIMUM_DISPLAY_NAME_LENGTH:
+            raise ValueError("Display name length longer than maximum allowed")
+        return display_name

appstoreserverlibrary/models/AdvancedCommerceEffective.py

@@ -0,0 +1,14 @@
+# Copyright (c) 2025 Apple Inc. Licensed under MIT License.
+
+from enum import Enum
+
+from .LibraryUtility import AppStoreServerLibraryEnumMeta
+
+class AdvancedCommerceEffective(str, Enum, metaclass=AppStoreServerLibraryEnumMeta):
+    """
+    A string value that indicates when a requested change to an auto-renewable subscription goes into effect.
+    
+    https://developer.apple.com/documentation/advancedcommerceapi/effective
+    """
+    IMMEDIATELY = "IMMEDIATELY"
+    NEXT_BILL_CYCLE = "NEXT_BILL_CYCLE"

appstoreserverlibrary/models/AdvancedCommerceOffer.py

@@ -0,0 +1,29 @@
+# Copyright (c) 2025 Apple Inc. Licensed under MIT License.
+
+from typing import Dict, Any, Optional
+
+from attr import define
+import attr
+
+from .LibraryUtility import AttrsRawValueAware, AppStoreServerLibraryEnumMeta
+from .AdvancedCommerceOfferPeriod import AdvancedCommerceOfferPeriod
+from .AdvancedCommerceOfferReason import AdvancedCommerceOfferReason
+
+@define
+class AdvancedCommerceOffer(AttrsRawValueAware):
+    """
+    A discount offer for an auto-renewable subscription.
+    
+    https://developer.apple.com/documentation/advancedcommerceapi/offer
+    """
+    
+    period: Optional[AdvancedCommerceOfferPeriod] = AdvancedCommerceOfferPeriod.create_main_attr("rawPeriod")
+    raw_period: Optional[str] = AdvancedCommerceOfferPeriod.create_raw_attr("period")
+    
+    period_count: Optional[int] = attr.ib(default=None)
+    price: Optional[int] = attr.ib(default=None)
+    
+    reason: Optional[AdvancedCommerceOfferReason] = AdvancedCommerceOfferReason.create_main_attr("rawReason")
+    raw_reason: Optional[str] = AdvancedCommerceOfferReason.create_raw_attr("reason")
+    
+    unknown_fields: Optional[Dict[str, Any]] = attr.ib(default=None)

appstoreserverlibrary/models/AdvancedCommerceOfferPeriod.py

@@ -0,0 +1,21 @@
+# Copyright (c) 2025 Apple Inc. Licensed under MIT License.
+
+from enum import Enum
+
+from .LibraryUtility import AppStoreServerLibraryEnumMeta
+
+class AdvancedCommerceOfferPeriod(str, Enum, metaclass=AppStoreServerLibraryEnumMeta):
+    """
+    The period of the offer.
+    
+    https://developer.apple.com/documentation/advancedcommerceapi/offer
+    """
+    P3D = "P3D"
+    P1W = "P1W"
+    P2W = "P2W"
+    P1M = "P1M"
+    P2M = "P2M"
+    P3M = "P3M"
+    P6M = "P6M"
+    P9M = "P9M"
+    P1Y = "P1Y"

appstoreserverlibrary/models/AdvancedCommerceOfferReason.py

@@ -0,0 +1,15 @@
+# Copyright (c) 2025 Apple Inc. Licensed under MIT License.
+
+from enum import Enum
+
+from .LibraryUtility import AppStoreServerLibraryEnumMeta
+
+class AdvancedCommerceOfferReason(str, Enum, metaclass=AppStoreServerLibraryEnumMeta):
+    """
+    The reason for the offer.
+    
+    https://developer.apple.com/documentation/advancedcommerceapi/offer
+    """
+    ACQUISITION = "ACQUISITION"
+    WIN_BACK = "WIN_BACK"
+    RETENTION = "RETENTION"

appstoreserverlibrary/models/AdvancedCommerceOneTimeChargeCreateRequest.py

@@ -0,0 +1,37 @@
+# Copyright (c) 2025 Apple Inc. Licensed under MIT License.
+
+from typing import Optional
+
+from attr import define
+import attr
+
+from .AbstractAdvancedCommerceInAppRequest import AbstractAdvancedCommerceInAppRequest
+from .AdvancedCommerceOneTimeChargeItem import AdvancedCommerceOneTimeChargeItem
+from .AdvancedCommerceRequestInfo import AdvancedCommerceRequestInfo
+from .AdvancedCommerceValidationUtils import AdvancedCommerceValidationUtils
+
+@define
+class AdvancedCommerceOneTimeChargeCreateRequest(AbstractAdvancedCommerceInAppRequest):
+    """
+    The request data your app provides when a customer purchases a one-time-charge product.
+    
+    https://developer.apple.com/documentation/advancedcommerceapi/onetimechargecreaterequest
+    """
+    
+    OPERATION = "CREATE_ONE_TIME_CHARGE"
+    VERSION = "1"
+    
+    currency: str = attr.ib()
+    item: AdvancedCommerceOneTimeChargeItem = attr.ib()
+    tax_code: str = attr.ib()
+    storefront: Optional[str] = attr.ib(default=None)
+    
+    def __attrs_post_init__(self):
+        super().__attrs_post_init__()
+        # Set the operation and version from constants
+        object.__setattr__(self, 'operation', self.OPERATION)
+        object.__setattr__(self, 'version', self.VERSION)
+        
+        # Validate fields
+        self.currency = AdvancedCommerceValidationUtils.validate_currency(self.currency)
+        self.tax_code = AdvancedCommerceValidationUtils.validate_tax_code(self.tax_code)

appstoreserverlibrary/models/AdvancedCommerceOneTimeChargeItem.py

@@ -0,0 +1,42 @@
+# Copyright (c) 2025 Apple Inc. Licensed under MIT License.
+
+from typing import Optional
+
+from attr import define
+import attr
+
+from .AbstractAdvancedCommerceItem import AbstractAdvancedCommerceItem
+
+@define
+class AdvancedCommerceOneTimeChargeItem(AbstractAdvancedCommerceItem):
+    """
+    The details of a one-time charge product, including its display name, price, SKU, and metadata.
+    
+    https://developer.apple.com/documentation/advancedcommerceapi/onetimechargeitem
+    """
+    
+    price: Optional[int] = attr.ib(default=None)
+    
+    def __attrs_post_init__(self):
+        super().__attrs_post_init__()
+        if self.price is not None:
+            self.price = self._validate_price(self.price)
+    
+    def _validate_price(self, price: int) -> int:
+        """
+        Validate price field.
+        
+        Args:
+            price: The price to validate
+            
+        Returns:
+            The validated price
+            
+        Raises:
+            ValueError: If price is invalid
+        """
+        if price is None:
+            raise ValueError("Price cannot be None")
+        if price < 0:
+            raise ValueError("Price cannot be negative")
+        return price