├── phpstan.neon
├── .gitignore
├── src
    ├── RequestQueryParams
    │   ├── GetRefundHistoryQueryParams.php
    │   ├── GetAllSubscriptionStatusesQueryParams.php
    │   ├── GetNotificationHistoryQueryParams.php
    │   ├── PageableQueryParams.php
    │   ├── AbstractRequestQueryParams.php
    │   └── GetTransactionHistoryQueryParams.php
    ├── Exception
    │   ├── AppStoreServerAPIException.php
    │   ├── AppStoreServerNotificationException.php
    │   ├── MalformedJWTException.php
    │   ├── MalformedResponseException.php
    │   ├── UnimplementedContentTypeException.php
    │   ├── HTTPRequestAborted.php
    │   ├── JWTCreationException.php
    │   ├── InvalidImplementationException.php
    │   ├── WrongEnvironmentException.php
    │   └── HTTPRequestFailed.php
    ├── Request
    │   ├── LookUpOrderIdRequest.php
    │   ├── GetRefundHistoryRequest.php
    │   ├── GetTransactionHistoryRequest.php
    │   ├── GetNotificationHistoryRequest.php
    │   ├── GetTransactionInfoRequest.php
    │   ├── RequestTestNotificationRequest.php
    │   ├── GetAllSubscriptionStatusesRequest.php
    │   ├── GetTestNotificationStatusRequest.php
    │   ├── SendConsumptionInformationRequest.php
    │   ├── MassExtendSubscriptionRenewalDateRequest.php
    │   ├── ExtendSubscriptionRenewalDateRequest.php
    │   ├── GetStatusOfSubscriptionRenewalDateExtensionsRequest.php
    │   ├── AbstractRequest.php
    │   └── AbstractRequestParamsBag.php
    ├── Environment.php
    ├── Key.php
    ├── Response
    │   ├── MassExtendRenewalDateResponse.php
    │   ├── SendTestNotificationResponse.php
    │   ├── CheckTestNotificationResponse.php
    │   ├── TransactionInfoResponse.php
    │   ├── AbstractResponse.php
    │   ├── NotificationHistoryResponse.php
    │   ├── RefundHistoryResponse.php
    │   ├── OrderLookupResponse.php
    │   ├── ExtendRenewalDateResponse.php
    │   ├── PageableResponse.php
    │   ├── MassExtendRenewalDateStatusResponse.php
    │   ├── StatusResponse.php
    │   └── HistoryResponse.php
    ├── RequestBody
    │   ├── AbstractRequestBody.php
    │   ├── ExtendRenewalDateRequestBody.php
    │   ├── MassExtendRenewalDateRequestBody.php
    │   ├── NotificationHistoryRequestBody.php
    │   └── ConsumptionRequestBody.php
    ├── Payload.php
    ├── SubscriptionGroupIdentifierItem.php
    ├── Util
    │   ├── Helper.php
    │   ├── ASN1SequenceOfInteger.php
    │   └── JWT.php
    ├── HTTPRequest.php
    ├── NotificationHistoryResponseItem.php
    ├── LastTransactionsItem.php
    ├── SendAttemptItem.php
    ├── AppMetadata.php
    ├── AppStoreServerAPIInterface.php
    ├── RenewalInfo.php
    ├── AppStoreServerAPI.php
    ├── TransactionInfo.php
    └── ResponseBodyV2.php
├── .php-cs-fixer.dist.php
├── composer.json
├── examples
    ├── getNotificationHistory.php
    ├── extendSubscriptionRenewalDate.php
    ├── massExtendSubscriptionRenewalDate.php
    ├── requestAndCheckTestNotification.php
    ├── sendConsumptionInformation.php
    ├── getStatusOfSubscriptionRenewalDateExtensionsRequest.php
    ├── client.php
    ├── getTransactionInfo.php
    ├── getRefundHistory.php
    ├── lookUpOrderId.php
    ├── getTransactionHistory.php
    ├── getAllSubscriptionStatuses.php
    └── serverNotificationV2.php
├── LICENSE
├── CHANGELOG.md
└── README.md


/phpstan.neon:
--------------------------------------------------------------------------------
1 | parameters:
2 | 	paths:
3 | 		- src
4 | 	level: 6
5 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | .idea/
2 | .php-cs-fixer.cache
3 | examples/credentials.json
4 | examples/notification.json
5 | vendor/
6 | 


--------------------------------------------------------------------------------
/src/RequestQueryParams/GetRefundHistoryQueryParams.php:
--------------------------------------------------------------------------------
1 | <?php
2 | declare(strict_types=1);
3 | 
4 | namespace Readdle\AppStoreServerAPI\RequestQueryParams;
5 | 
6 | final class GetRefundHistoryQueryParams extends PageableQueryParams
7 | {
8 | }
9 | 


--------------------------------------------------------------------------------
/src/Exception/AppStoreServerAPIException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Exception;
 5 | 
 6 | use Exception;
 7 | 
 8 | abstract class AppStoreServerAPIException extends Exception
 9 | {
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Exception/AppStoreServerNotificationException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Exception;
 5 | 
 6 | use Exception;
 7 | 
 8 | final class AppStoreServerNotificationException extends Exception
 9 | {
10 | }
11 | 


--------------------------------------------------------------------------------
/.php-cs-fixer.dist.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | $finder = (new PhpCsFixer\Finder())->in(__DIR__);
 4 | 
 5 | return (new PhpCsFixer\Config())->setRules([
 6 |     '@PSR1' => true,
 7 |     '@PSR2' => true,
 8 |     'blank_line_after_opening_tag' => false,
 9 | ])->setFinder($finder);
10 | 


--------------------------------------------------------------------------------
/src/Exception/MalformedJWTException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Exception;
 5 | 
 6 | final class MalformedJWTException extends AppStoreServerAPIException
 7 | {
 8 |     public function __construct(string $message)
 9 |     {
10 |         parent::__construct("JWT is malformed: $message");
11 |     }
12 | }
13 | 


--------------------------------------------------------------------------------
/src/Exception/MalformedResponseException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Exception;
 5 | 
 6 | final class MalformedResponseException extends AppStoreServerAPIException
 7 | {
 8 |     public function __construct(string $message)
 9 |     {
10 |         parent::__construct("Malformed response: $message");
11 |     }
12 | }
13 | 


--------------------------------------------------------------------------------
/src/Exception/UnimplementedContentTypeException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Exception;
 5 | 
 6 | final class UnimplementedContentTypeException extends AppStoreServerAPIException
 7 | {
 8 |     public function __construct(string $contentType)
 9 |     {
10 |         parent::__construct("Unimplemented content type $contentType");
11 |     }
12 | }
13 | 


--------------------------------------------------------------------------------
/src/Exception/HTTPRequestAborted.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Exception;
 5 | 
 6 | use Throwable;
 7 | 
 8 | final class HTTPRequestAborted extends AppStoreServerAPIException
 9 | {
10 |     public function __construct(string $message, Throwable $previous)
11 |     {
12 |         parent::__construct("HTTP request aborted: $message", 0, $previous);
13 |     }
14 | }
15 | 


--------------------------------------------------------------------------------
/src/Exception/JWTCreationException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Exception;
 5 | 
 6 | use Throwable;
 7 | 
 8 | final class JWTCreationException extends AppStoreServerAPIException
 9 | {
10 |     public function __construct(string $message, Throwable $previous = null)
11 |     {
12 |         parent::__construct("JWT creation error: $message", 0, $previous);
13 |     }
14 | }
15 | 


--------------------------------------------------------------------------------
/src/Request/LookUpOrderIdRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Request;
 5 | 
 6 | final class LookUpOrderIdRequest extends AbstractRequest
 7 | {
 8 |     public function getHTTPMethod(): string
 9 |     {
10 |         return self::HTTP_METHOD_GET;
11 |     }
12 | 
13 |     protected function getURLPattern(): string
14 |     {
15 |         return '{baseUrl}/v1/lookup/{orderId}';
16 |     }
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Exception/InvalidImplementationException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Exception;
 5 | 
 6 | final class InvalidImplementationException extends AppStoreServerAPIException
 7 | {
 8 |     public function __construct(string $requestClass, string $responseClass)
 9 |     {
10 |         parent::__construct("Invalid implementation of request $requestClass and/or response $responseClass");
11 |     }
12 | }
13 | 


--------------------------------------------------------------------------------
/src/Request/GetRefundHistoryRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Request;
 5 | 
 6 | final class GetRefundHistoryRequest extends AbstractRequest
 7 | {
 8 |     public function getHTTPMethod(): string
 9 |     {
10 |         return self::HTTP_METHOD_GET;
11 |     }
12 | 
13 |     protected function getURLPattern(): string
14 |     {
15 |         return '{baseUrl}/v2/refund/lookup/{transactionId}';
16 |     }
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Request/GetTransactionHistoryRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Request;
 5 | 
 6 | class GetTransactionHistoryRequest extends AbstractRequest
 7 | {
 8 |     public function getHTTPMethod(): string
 9 |     {
10 |         return self::HTTP_METHOD_GET;
11 |     }
12 | 
13 |     protected function getURLPattern(): string
14 |     {
15 |         return '{baseUrl}/v1/history/{transactionId}';
16 |     }
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Request/GetNotificationHistoryRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Request;
 5 | 
 6 | final class GetNotificationHistoryRequest extends AbstractRequest
 7 | {
 8 |     public function getHTTPMethod(): string
 9 |     {
10 |         return self::HTTP_METHOD_POST;
11 |     }
12 | 
13 |     protected function getURLPattern(): string
14 |     {
15 |         return '{baseUrl}/v1/notifications/history';
16 |     }
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Request/GetTransactionInfoRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Request;
 5 | 
 6 | final class GetTransactionInfoRequest extends AbstractRequest
 7 | {
 8 |     public function getHTTPMethod(): string
 9 |     {
10 |         return self::HTTP_METHOD_GET;
11 |     }
12 | 
13 |     protected function getURLPattern(): string
14 |     {
15 |         return '{baseUrl}/v1/transactions/{transactionId}';
16 |     }
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Request/RequestTestNotificationRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Request;
 5 | 
 6 | final class RequestTestNotificationRequest extends AbstractRequest
 7 | {
 8 |     public function getHTTPMethod(): string
 9 |     {
10 |         return self::HTTP_METHOD_POST;
11 |     }
12 | 
13 |     protected function getURLPattern(): string
14 |     {
15 |         return '{baseUrl}/v1/notifications/test';
16 |     }
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Request/GetAllSubscriptionStatusesRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Request;
 5 | 
 6 | class GetAllSubscriptionStatusesRequest extends AbstractRequest
 7 | {
 8 |     public function getHTTPMethod(): string
 9 |     {
10 |         return self::HTTP_METHOD_GET;
11 |     }
12 | 
13 |     protected function getURLPattern(): string
14 |     {
15 |         return '{baseUrl}/v1/subscriptions/{transactionId}';
16 |     }
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Request/GetTestNotificationStatusRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Request;
 5 | 
 6 | final class GetTestNotificationStatusRequest extends AbstractRequest
 7 | {
 8 |     public function getHTTPMethod(): string
 9 |     {
10 |         return self::HTTP_METHOD_GET;
11 |     }
12 | 
13 |     protected function getURLPattern(): string
14 |     {
15 |         return '{baseUrl}/v1/notifications/test/{testNotificationToken}';
16 |     }
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Request/SendConsumptionInformationRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Request;
 5 | 
 6 | final class SendConsumptionInformationRequest extends AbstractRequest
 7 | {
 8 |     public function getHTTPMethod(): string
 9 |     {
10 |         return self::HTTP_METHOD_PUT;
11 |     }
12 | 
13 |     protected function getURLPattern(): string
14 |     {
15 |         return '{baseUrl}/v1/transactions/consumption/{transactionId}';
16 |     }
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Request/MassExtendSubscriptionRenewalDateRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Request;
 5 | 
 6 | final class MassExtendSubscriptionRenewalDateRequest extends AbstractRequest
 7 | {
 8 |     public function getHTTPMethod(): string
 9 |     {
10 |         return self::HTTP_METHOD_POST;
11 |     }
12 | 
13 |     protected function getURLPattern(): string
14 |     {
15 |         return '{baseUrl}/v1/subscriptions/extend/mass/';
16 |     }
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Request/ExtendSubscriptionRenewalDateRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Request;
 5 | 
 6 | final class ExtendSubscriptionRenewalDateRequest extends AbstractRequest
 7 | {
 8 |     public function getHTTPMethod(): string
 9 |     {
10 |         return self::HTTP_METHOD_PUT;
11 |     }
12 | 
13 |     protected function getURLPattern(): string
14 |     {
15 |         return '{baseUrl}/v1/subscriptions/extend/{originalTransactionId}';
16 |     }
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Environment.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI;
 5 | 
 6 | final class Environment
 7 | {
 8 |     /**
 9 |      * Indicates that the data/notification applies to the production environment.
10 |      *
11 |      * @var string
12 |      */
13 |     const PRODUCTION = 'Production';
14 | 
15 |     /**
16 |      * Indicates that the data/notification applies to testing in the sandbox environment.
17 |      *
18 |      * @var string
19 |      */
20 |     const SANDBOX = 'Sandbox';
21 | }
22 | 


--------------------------------------------------------------------------------
/src/RequestQueryParams/GetAllSubscriptionStatusesQueryParams.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\RequestQueryParams;
 5 | 
 6 | final class GetAllSubscriptionStatusesQueryParams extends AbstractRequestQueryParams
 7 | {
 8 |     /**
 9 |      * An optional filter that indicates the status of subscriptions to include in the response.
10 |      * Your query may specify more than one status query parameter.
11 |      *
12 |      * @var array<int>
13 |      */
14 |     protected array $status = [];
15 | }
16 | 


--------------------------------------------------------------------------------
/src/Request/GetStatusOfSubscriptionRenewalDateExtensionsRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Request;
 5 | 
 6 | final class GetStatusOfSubscriptionRenewalDateExtensionsRequest extends AbstractRequest
 7 | {
 8 |     public function getHTTPMethod(): string
 9 |     {
10 |         return self::HTTP_METHOD_GET;
11 |     }
12 | 
13 |     protected function getURLPattern(): string
14 |     {
15 |         return '{baseUrl}/v1/subscriptions/extend/mass/{productId}/{requestIdentifier}';
16 |     }
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Key.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI;
 5 | 
 6 | final class Key
 7 | {
 8 |     private string $keyId;
 9 |     private string $key;
10 | 
11 |     public function __construct(string $keyId, string $key)
12 |     {
13 |         $this->keyId = $keyId;
14 |         $this->key = $key;
15 |     }
16 | 
17 |     public function getKeyId(): string
18 |     {
19 |         return $this->keyId;
20 |     }
21 | 
22 |     public function getKey(): string
23 |     {
24 |         return $this->key;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Exception/WrongEnvironmentException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Exception;
 5 | 
 6 | use Readdle\AppStoreServerAPI\Environment;
 7 | 
 8 | final class WrongEnvironmentException extends AppStoreServerAPIException
 9 | {
10 |     public function __construct(string $environment)
11 |     {
12 |         parent::__construct(sprintf(
13 |             'Environment should be either Environment::PRODUCTION (%s) or Environment::SANDBOX (%s), %s is passed',
14 |             Environment::PRODUCTION,
15 |             Environment::SANDBOX,
16 |             $environment
17 |         ));
18 |     }
19 | }
20 | 


--------------------------------------------------------------------------------
/src/Response/MassExtendRenewalDateResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Response;
 5 | 
 6 | use Readdle\AppStoreServerAPI\Request\AbstractRequest;
 7 | 
 8 | /**
 9 |  * @method static MassExtendRenewalDateResponse createFromString(string $string, AbstractRequest $originalRequest)
10 |  */
11 | final class MassExtendRenewalDateResponse extends AbstractResponse
12 | {
13 |     /**
14 |      * A string that contains the UUID that identifies the subscription-renewal-date extension request.
15 |      */
16 |     protected string $requestIdentifier;
17 | 
18 |     /**
19 |      * returns a string that contains the UUID that identifies the subscription-renewal-date extension request.
20 |      */
21 |     public function getRequestIdentifier(): string
22 |     {
23 |         return $this->requestIdentifier;
24 |     }
25 | }
26 | 


--------------------------------------------------------------------------------
/src/RequestQueryParams/GetNotificationHistoryQueryParams.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\RequestQueryParams;
 5 | 
 6 | final class GetNotificationHistoryQueryParams extends PageableQueryParams
 7 | {
 8 |     public function __construct(array $params = [])
 9 |     {
10 |         if (isset($params['paginationToken'])) {
11 |             $params['revision'] = $params['paginationToken'];
12 |             unset($params['paginationToken']);
13 |         }
14 | 
15 |         parent::__construct($params);
16 |     }
17 | 
18 |     protected function collectProps(): array
19 |     {
20 |         $props = parent::collectProps();
21 | 
22 |         if (!empty($props['revision'])) {
23 |             $props['paginationToken'] = $props['revision'];
24 |             unset($props['revision']);
25 |         }
26 | 
27 |         return $props;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/RequestQueryParams/PageableQueryParams.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\RequestQueryParams;
 5 | 
 6 | abstract class PageableQueryParams extends AbstractRequestQueryParams
 7 | {
 8 |     /**
 9 |      * A token you provide to get the next set of items. All responses include a revision token.
10 |      *
11 |      * NOTE: For requests that use the revision token, include the same query parameters from the initial request.
12 |      * Use the revision token from the previous response.
13 |      * The revision token is required in all requests except the initial one.
14 |      */
15 |     protected string $revision = '';
16 | 
17 |     public function forRevision(string $revision): PageableQueryParams
18 |     {
19 |         $newQueryParams = clone $this;
20 |         $newQueryParams->revision = $revision;
21 |         return $newQueryParams;
22 |     }
23 | }
24 | 


--------------------------------------------------------------------------------
/src/Exception/HTTPRequestFailed.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Readdle\AppStoreServerAPI\Exception;
 6 | 
 7 | final class HTTPRequestFailed extends AppStoreServerAPIException
 8 | {
 9 |     public string $responseText;
10 | 
11 |     public function __construct(string $method, string $url, string $message, int $code = 0)
12 |     {
13 |         $this->responseText = $message;
14 | 
15 |         if ($code === 0) {
16 |             parent::__construct("HTTP request [$method $url] failed: $message");
17 |         } else {
18 |             parent::__construct("HTTP request [$method $url] failed with status code $code. Response text is: $message", $code);
19 |         }
20 |     }
21 | 
22 |     /**
23 |      * Get the response text
24 |      *
25 |      * @return string
26 |      */
27 |     public function getResponseText(): string
28 |     {
29 |         return $this->responseText;
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Response/SendTestNotificationResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Response;
 5 | 
 6 | use Readdle\AppStoreServerAPI\Request\AbstractRequest;
 7 | 
 8 | /**
 9 |  * @method static SendTestNotificationResponse createFromString(string $string, AbstractRequest $originalRequest)
10 |  */
11 | final class SendTestNotificationResponse extends AbstractResponse
12 | {
13 |     /**
14 |      * The test notification token that uniquely identifies the notification test that
15 |      * App Store Server Notifications sends to your server.
16 |      */
17 |     protected string $testNotificationToken;
18 | 
19 |     /**
20 |      * Returns the test notification token that uniquely identifies the notification test that
21 |      * App Store Server Notifications sends to your server.
22 |      */
23 |     public function getTestNotificationToken(): string
24 |     {
25 |         return $this->testNotificationToken;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/RequestBody/AbstractRequestBody.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\RequestBody;
 5 | 
 6 | use Readdle\AppStoreServerAPI\Exception\UnimplementedContentTypeException;
 7 | use Readdle\AppStoreServerAPI\Request\AbstractRequestParamsBag;
 8 | 
 9 | abstract class AbstractRequestBody extends AbstractRequestParamsBag
10 | {
11 |     const CONTENT_TYPE__JSON = 'application/json';
12 | 
13 |     public function getContentType(): string
14 |     {
15 |         return self::CONTENT_TYPE__JSON;
16 |     }
17 | 
18 |     /**
19 |      * @throws UnimplementedContentTypeException
20 |      */
21 |     public function getEncodedContent(): string
22 |     {
23 |         switch ($this->getContentType()) {
24 |             case self::CONTENT_TYPE__JSON:
25 |                 return json_encode($this->collectProps());
26 | 
27 |             default:
28 |                 throw new UnimplementedContentTypeException($this->getContentType());
29 |         }
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/src/RequestQueryParams/AbstractRequestQueryParams.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\RequestQueryParams;
 5 | 
 6 | use Readdle\AppStoreServerAPI\Request\AbstractRequestParamsBag;
 7 | 
 8 | use function array_map;
 9 | use function array_merge;
10 | use function join;
11 | use function rawurlencode;
12 | 
13 | abstract class AbstractRequestQueryParams extends AbstractRequestParamsBag
14 | {
15 |     public function getQueryString(): string
16 |     {
17 |         $queryStringParams = [];
18 | 
19 |         foreach ($this->collectProps() as $propName => $value) {
20 |             if (is_array($value)) {
21 |                 $queryStringParams = array_merge(
22 |                     $queryStringParams,
23 |                     array_map(fn ($v) => $propName . '=' . rawurlencode($v), $value)
24 |                 );
25 |             } else {
26 |                 $queryStringParams[] = $propName . '=' . rawurlencode($value);
27 |             }
28 |         }
29 | 
30 |         return join('&', $queryStringParams);
31 |     }
32 | }
33 | 


--------------------------------------------------------------------------------
/src/Response/CheckTestNotificationResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Response;
 5 | 
 6 | use Readdle\AppStoreServerAPI\NotificationHistoryResponseItem;
 7 | use Readdle\AppStoreServerAPI\Request\AbstractRequest;
 8 | 
 9 | /**
10 |  * @method static CheckTestNotificationResponse createFromString(string $string, AbstractRequest $originalRequest)
11 |  */
12 | final class CheckTestNotificationResponse extends AbstractResponse
13 | {
14 |     private NotificationHistoryResponseItem $notificationHistoryResponseItem;
15 | 
16 |     protected function __construct(array $properties, AbstractRequest $originalRequest)
17 |     {
18 |         $this->notificationHistoryResponseItem = NotificationHistoryResponseItem::createFromRawItem($properties);
19 |         $properties = [];
20 |         parent::__construct($properties, $originalRequest);
21 |     }
22 | 
23 |     public function getNotificationHistoryResponseItem(): NotificationHistoryResponseItem
24 |     {
25 |         return $this->notificationHistoryResponseItem;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 | 	"name": "readdle/app-store-server-api",
 3 | 	"description": "Pure-PHP library that allows managing customer transactions using the App Store Server API and handling server-to-server notifications using the App Store Server Notifications V2",
 4 | 	"type": "library",
 5 | 	"license": "MIT",
 6 | 	"authors": [
 7 | 		{
 8 | 			"name": "Pavlo Kotets",
 9 | 			"email": "pkotets@readdle.com",
10 | 			"homepage": "https://github.com/pkotets"
11 | 		}
12 | 	],
13 | 	"keywords": [
14 | 		"app store",
15 | 		"server api",
16 | 		"server notifications",
17 | 		"itunes",
18 | 		"apple",
19 | 		"in app",
20 | 		"purchase",
21 | 		"parser",
22 | 		"server-to-server",
23 | 		"php"
24 | 	],
25 | 	"homepage": "https://github.com/readdle/app-store-server-api",
26 | 	"version": "3.6.3",
27 | 	"php": ">=7.4",
28 | 	"autoload": {
29 | 		"psr-4": {
30 | 			"Readdle\\AppStoreServerAPI\\": "src/"
31 | 		}
32 | 	},
33 | 	"require": {
34 | 		"ext-json": "*",
35 | 		"ext-openssl": "*"
36 | 	},
37 | 	"require-dev": {
38 | 		"friendsofphp/php-cs-fixer": "^3.23",
39 | 		"phpstan/phpstan": "^1.10"
40 | 	}
41 | }
42 | 


--------------------------------------------------------------------------------
/examples/getNotificationHistory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | ['api' => $api, 'credentials' => $credentials] = require 'client.php';
 5 | 
 6 | use Readdle\AppStoreServerAPI\Exception\AppStoreServerAPIException;
 7 | 
 8 | try {
 9 |     $notificationHistoryResponse = $api->getNotificationHistory(['startDate' => (time() - 60 * 60) * 1000]);
10 |     $notificationHistoryResponseItems = $notificationHistoryResponse->getNotificationHistory();
11 | } catch (AppStoreServerAPIException $e) {
12 |     exit($e->getMessage());
13 | }
14 | 
15 | foreach ($notificationHistoryResponseItems as $notificationHistoryResponseItem) {
16 |     echo "\nSend attempts\n";
17 | 
18 |     foreach ($notificationHistoryResponseItem->getSendAttempts() as $sendAttempt) {
19 |         echo "Attempt Date: {$sendAttempt->getAttemptDate()}\n";
20 |         echo "Attempt Result: {$sendAttempt->getSendAttemptResult()}\n\n";
21 |     }
22 | 
23 |     echo "Signed Payload: {$notificationHistoryResponseItem->getSignedPayload()}\n";
24 |     echo 'ResponseBodyV2 as JSON: ' . json_encode($notificationHistoryResponseItem->getResponseBodyV2()) . "\n";
25 | 
26 | }
27 | 


--------------------------------------------------------------------------------
/examples/extendSubscriptionRenewalDate.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | ['api' => $api, 'credentials' => $credentials] = require 'client.php';
 5 | 
 6 | use Readdle\AppStoreServerAPI\Exception\AppStoreServerAPIException;
 7 | use Readdle\AppStoreServerAPI\RequestBody\ExtendRenewalDateRequestBody;
 8 | 
 9 | try {
10 |     $extendRenewalDateResponse = $api->extendSubscriptionRenewalDate(
11 |         $credentials['transactionId'],
12 |         [
13 |             'extendByDays' => 1,
14 |             'extendReasonCode' => ExtendRenewalDateRequestBody::EXTEND_REASON_CODE__UNDECLARED,
15 |             'requestIdentifier' => 'test',
16 |         ]
17 |     );
18 | } catch (AppStoreServerAPIException $e) {
19 |     exit($e->getMessage());
20 | } catch (Exception $e) {
21 |     exit("Wrong request body: {$e->getMessage()}");
22 | }
23 | 
24 | echo "Extend renewal date\n\n";
25 | echo "Effective Date: {$extendRenewalDateResponse->getEffectiveDate()}\n";
26 | echo "Original Transaction ID: {$extendRenewalDateResponse->getOriginalTransactionId()}\n";
27 | echo "Web Order Line Item ID: {$extendRenewalDateResponse->getWebOrderLineItemId()}\n";
28 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2022 Readdle Inc.
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/examples/massExtendSubscriptionRenewalDate.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | ['api' => $api, 'credentials' => $credentials] = require 'client.php';
 5 | 
 6 | if (empty($credentials['productId'])) {
 7 |     exit('You have to specify productId in order to request mass subscription renewal date extension');
 8 | }
 9 | 
10 | use Readdle\AppStoreServerAPI\Exception\AppStoreServerAPIException;
11 | use Readdle\AppStoreServerAPI\RequestBody\ExtendRenewalDateRequestBody;
12 | 
13 | try {
14 |     $massExtendRenewalDateResponse = $api->massExtendSubscriptionRenewalDate([
15 |         'extendByDays' => 1,
16 |         'extendReasonCode' => ExtendRenewalDateRequestBody::EXTEND_REASON_CODE__UNDECLARED,
17 |         'productId' => $credentials['productId'],
18 |         'requestIdentifier' => vsprintf('%s%s-%s-%s-%s-%s%s%s', str_split(bin2hex(random_bytes(16)), 4)),
19 |         'storefrontCountryCodes' => ['POL']
20 |     ]);
21 | } catch (AppStoreServerAPIException $e) {
22 |     exit($e->getMessage());
23 | } catch (Exception $e) {
24 |     exit("Wrong request body: {$e->getMessage()}");
25 | }
26 | 
27 | echo "Mass extend renewal date\n\n";
28 | echo "Request Identifier: {$massExtendRenewalDateResponse->getRequestIdentifier()}\n";
29 | 


--------------------------------------------------------------------------------
/examples/requestAndCheckTestNotification.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | ['api' => $api, 'credentials' => $credentials] = require 'client.php';
 5 | 
 6 | use Readdle\AppStoreServerAPI\Exception\AppStoreServerAPIException;
 7 | 
 8 | try {
 9 |     $testNotification = $api->requestTestNotification();
10 | } catch (AppStoreServerAPIException $e) {
11 |     exit($e->getMessage());
12 | }
13 | 
14 | echo "Test notification token: {$testNotification->getTestNotificationToken()}\n";
15 | 
16 | try {
17 |     $testNotificationStatus = $api->getTestNotificationStatus($testNotification->getTestNotificationToken());
18 | } catch (AppStoreServerAPIException $e) {
19 |     exit($e->getMessage());
20 | }
21 | 
22 | $notificationHistoryResponseItem = $testNotificationStatus->getNotificationHistoryResponseItem();
23 | 
24 | echo "\nSend attempts\n";
25 | 
26 | foreach ($notificationHistoryResponseItem->getSendAttempts() as $sendAttempt) {
27 |     echo "Attempt Date: {$sendAttempt->getAttemptDate()}\n";
28 |     echo "Attempt Result: {$sendAttempt->getSendAttemptResult()}\n";
29 | }
30 | 
31 | echo "Signed Payload: {$notificationHistoryResponseItem->getSignedPayload()}\n";
32 | echo 'ResponseBodyV2 as JSON: ' . json_encode($notificationHistoryResponseItem->getResponseBodyV2()) . "\n";
33 | 


--------------------------------------------------------------------------------
/examples/sendConsumptionInformation.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | ['api' => $api, 'credentials' => $credentials] = require 'client.php';
 5 | 
 6 | use Readdle\AppStoreServerAPI\Exception\AppStoreServerAPIException;
 7 | use Readdle\AppStoreServerAPI\RequestBody\ConsumptionRequestBody;
 8 | 
 9 | try {
10 |     $api->sendConsumptionInformation($credentials['transactionId'], [
11 |         'accountTenure' => ConsumptionRequestBody::ACCOUNT_TENURE__UNDECLARED,
12 |         'appAccountToken' => '',
13 |         'consumptionStatus' => ConsumptionRequestBody::CONSUMPTION_STATUS__UNDECLARED,
14 |         'customerConsented' => true,
15 |         'deliveryStatus' => ConsumptionRequestBody::DELIVERY_STATUS__DELIVERED,
16 |         'lifetimeDollarsPurchased' => ConsumptionRequestBody::LIFETIME_DOLLARS_PURCHASED__UNDECLARED,
17 |         'lifetimeDollarsRefunded' => ConsumptionRequestBody::LIFETIME_DOLLARS_REFUNDED__UNDECLARED,
18 |         'platform' => ConsumptionRequestBody::PLATFORM__UNDECLARED,
19 |         'playTime' => ConsumptionRequestBody::PLAY_TIME__UNDECLARED,
20 |         'sampleContentProvided' => true,
21 |         'userStatus' => ConsumptionRequestBody::USER_STATUS__UNDECLARED,
22 |     ]);
23 | } catch (AppStoreServerAPIException $e) {
24 |     exit($e->getMessage());
25 | }
26 | 
27 | echo "Consumption information sent\n";
28 | 


--------------------------------------------------------------------------------
/src/Response/TransactionInfoResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Response;
 5 | 
 6 | use Readdle\AppStoreServerAPI\Exception\MalformedJWTException;
 7 | use Readdle\AppStoreServerAPI\Util\JWT;
 8 | use Readdle\AppStoreServerAPI\Request\AbstractRequest;
 9 | use Readdle\AppStoreServerAPI\TransactionInfo;
10 | 
11 | /**
12 |  * @method static TransactionInfoResponse createFromString(string $string, AbstractRequest $originalRequest)
13 |  */
14 | final class TransactionInfoResponse extends AbstractResponse
15 | {
16 |     /**
17 |      * A customer's in-app purchase transaction.
18 |      */
19 |     protected TransactionInfo $transactionInfo;
20 | 
21 |     /**
22 |      * @throws MalformedJWTException
23 |      */
24 |     protected function __construct(array $properties, AbstractRequest $originalRequest)
25 |     {
26 |         $this->transactionInfo = TransactionInfo::createFromRawTransactionInfo(JWT::parse($properties['signedTransactionInfo']));
27 |         unset($properties['signedTransactionInfo']);
28 |         parent::__construct($properties, $originalRequest);
29 |     }
30 | 
31 |     /**
32 |      * Returns a customer's in-app purchase transaction.
33 |      */
34 |     public function getTransactionInfo(): TransactionInfo
35 |     {
36 |         return $this->transactionInfo;
37 |     }
38 | }
39 | 


--------------------------------------------------------------------------------
/examples/getStatusOfSubscriptionRenewalDateExtensionsRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | ['api' => $api, 'credentials' => $credentials] = require 'client.php';
 5 | 
 6 | if (empty($credentials['productId'])) {
 7 |     exit('You have to specify productId in order to get status of subscription renewal date extension request');
 8 | }
 9 | 
10 | if (empty($credentials['requestIdentifier'])) {
11 |     exit('You have to specify requestIdentifier in order to get status of subscription renewal date extension request');
12 | }
13 | 
14 | use Readdle\AppStoreServerAPI\Exception\AppStoreServerAPIException;
15 | 
16 | try {
17 |     $massExtendRenewalDateStatusResponse = $api->getStatusOfSubscriptionRenewalDateExtensionsRequest(
18 |         $credentials['productId'],
19 |         $credentials['requestIdentifier'],
20 |     );
21 | } catch (AppStoreServerAPIException $e) {
22 |     exit($e->getMessage());
23 | }
24 | 
25 | echo "Mass extend renewal date status\n\n";
26 | 
27 | echo "Complete Date: {$massExtendRenewalDateStatusResponse->getCompleteDate()}\n";
28 | echo 'Is Complete: ' . ($massExtendRenewalDateStatusResponse->isComplete() ? 'yes' : 'no') . "\n";
29 | echo "Request Identifier: {$massExtendRenewalDateStatusResponse->getRequestIdentifier()}\n";
30 | echo "Failed Count: {$massExtendRenewalDateStatusResponse->getFailedCount()}\n";
31 | echo "Succeeded Count: {$massExtendRenewalDateStatusResponse->getSucceededCount()}\n";
32 | 


--------------------------------------------------------------------------------
/src/Payload.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI;
 5 | 
 6 | use function min;
 7 | use function time;
 8 | 
 9 | final class Payload
10 | {
11 |     const MAX_TTL = 3600;
12 | 
13 |     /**
14 |      * Issuer ID from the Keys page in App Store Connect (Ex: "57246542-96fe-1a63-e053-0824d011072a").
15 |      */
16 |     private string $issuerId;
17 | 
18 |     /**
19 |      * Audience.
20 |      * Constant value.
21 |      * @noinspection SpellCheckingInspection
22 |      */
23 |     private string $audience = 'appstoreconnect-v1';
24 | 
25 |     /**
26 |      * App's bundle ID (Ex: “com.example.testBundleId2021”).
27 |      */
28 |     private string $bundleId;
29 | 
30 |     private int $ttl;
31 | 
32 |     public function __construct(string $issuerId, string $bundleId, int $ttl = 0)
33 |     {
34 |         $this->issuerId = $issuerId;
35 |         $this->bundleId = $bundleId;
36 | 
37 |         $this->ttl = $ttl === 0 ? self::MAX_TTL : min($ttl, self::MAX_TTL);
38 |     }
39 | 
40 |     /**
41 |      * @return array<string, int|string>
42 |      */
43 |     public function toArray(): array
44 |     {
45 |         $time = time();
46 | 
47 |         return [
48 |             'iss' => $this->issuerId,
49 |             'iat' => $time,
50 |             'exp' => $time + $this->ttl,
51 |             'aud' => $this->audience,
52 |             'bid' => $this->bundleId,
53 |         ];
54 |     }
55 | }
56 | 


--------------------------------------------------------------------------------
/src/Response/AbstractResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Response;
 5 | 
 6 | use Readdle\AppStoreServerAPI\Exception\MalformedResponseException;
 7 | use Readdle\AppStoreServerAPI\Request\AbstractRequest;
 8 | 
 9 | use function json_decode;
10 | use function json_last_error;
11 | use function property_exists;
12 | 
13 | use const JSON_ERROR_NONE;
14 | 
15 | /** @phpstan-consistent-constructor */
16 | abstract class AbstractResponse
17 | {
18 |     protected AbstractRequest $originalRequest;
19 | 
20 |     /**
21 |      * @param array<string, mixed> $properties
22 |      */
23 |     protected function __construct(array $properties, AbstractRequest $originalRequest)
24 |     {
25 |         $this->originalRequest = $originalRequest;
26 | 
27 |         foreach ($properties as $key => $value) {
28 |             if (property_exists($this, $key)) {
29 |                 $this->$key = $value;
30 |             }
31 |         }
32 |     }
33 | 
34 |     /**
35 |      * @return AbstractResponse|PageableResponse
36 |      * @throws MalformedResponseException
37 |      */
38 |     public static function createFromString(string $string, AbstractRequest $originalRequest): AbstractResponse
39 |     {
40 |         $array = json_decode($string, true);
41 | 
42 |         if (json_last_error() !== JSON_ERROR_NONE) {
43 |             throw new MalformedResponseException('Invalid JSON');
44 |         }
45 | 
46 |         return new static($array, $originalRequest);
47 |     }
48 | }
49 | 


--------------------------------------------------------------------------------
/examples/client.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | require_once '../vendor/autoload.php';
 5 | 
 6 | use Readdle\AppStoreServerAPI\AppStoreServerAPI;
 7 | use Readdle\AppStoreServerAPI\Environment;
 8 | use Readdle\AppStoreServerAPI\Exception\WrongEnvironmentException;
 9 | 
10 | $filename = 'credentials.json';
11 | $keys = ['issuerId', 'bundleId', 'keyId', 'key', 'transactionId', 'env'];
12 | 
13 | if (!file_exists($filename)) {
14 |     exit("You have to create `$filename` and put your [" . join(',', $keys) . "] there");
15 | }
16 | 
17 | $credentialsRaw = file_get_contents($filename);
18 | 
19 | if (!$credentialsRaw) {
20 |     exit("`$filename` could not be read or is empty");
21 | }
22 | 
23 | $credentials = json_decode($credentialsRaw, true);
24 | 
25 | if (json_last_error() !== JSON_ERROR_NONE) {
26 |     exit("`$filename` contains invalid JSON");
27 | }
28 | 
29 | if (array_diff($keys, array_keys($credentials))) {
30 |     exit("Check `$filename` for presence of the following keys: " . join(',', $keys));
31 | }
32 | 
33 | if (!in_array($credentials['env'], [Environment::PRODUCTION, Environment::SANDBOX])) {
34 |     exit("`$filename` contains invalid environment name: {$credentials['env']}");
35 | }
36 | 
37 | try {
38 |     $api = new AppStoreServerAPI(
39 |         $credentials['env'],
40 |         $credentials['issuerId'],
41 |         $credentials['bundleId'],
42 |         $credentials['keyId'],
43 |         $credentials['key']
44 |     );
45 | } catch (WrongEnvironmentException $e) {
46 |     exit($e->getMessage());
47 | }
48 | 
49 | return [
50 |     'api' => $api,
51 |     'credentials' => $credentials,
52 | ];
53 | 


--------------------------------------------------------------------------------
/src/Response/NotificationHistoryResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Response;
 5 | 
 6 | use Generator;
 7 | use Readdle\AppStoreServerAPI\Exception\HTTPRequestAborted;
 8 | use Readdle\AppStoreServerAPI\Exception\HTTPRequestFailed;
 9 | use Readdle\AppStoreServerAPI\Exception\MalformedResponseException;
10 | use Readdle\AppStoreServerAPI\Exception\UnimplementedContentTypeException;
11 | use Readdle\AppStoreServerAPI\NotificationHistoryResponseItem;
12 | use Readdle\AppStoreServerAPI\Request\AbstractRequest;
13 | 
14 | /**
15 |  * @method static NotificationHistoryResponse createFromString(string $string, AbstractRequest $originalRequest)
16 |  */
17 | final class NotificationHistoryResponse extends PageableResponse
18 | {
19 |     protected function __construct(array $properties, AbstractRequest $originalRequest)
20 |     {
21 |         foreach ($properties['notificationHistory'] as $rawResponseItem) {
22 |             $this->items[] = NotificationHistoryResponseItem::createFromRawItem($rawResponseItem);
23 |         }
24 | 
25 |         if (!empty($properties['paginationToken'])) {
26 |             $properties['revision'] = $properties['paginationToken'];
27 |         }
28 | 
29 |         unset($properties['notificationHistory'], $properties['paginationToken']);
30 |         parent::__construct($properties, $originalRequest);
31 |     }
32 | 
33 |     /**
34 |      * Returns a Generator which iterates over an array of App Store Server Notifications history records.
35 |      *
36 |      * @return Generator<NotificationHistoryResponseItem>
37 |      *
38 |      * @throws MalformedResponseException
39 |      * @throws HTTPRequestAborted
40 |      * @throws HTTPRequestFailed
41 |      * @throws UnimplementedContentTypeException
42 |      */
43 |     public function getNotificationHistory(): Generator
44 |     {
45 |         return $this->getItems();
46 |     }
47 | }
48 | 


--------------------------------------------------------------------------------
/src/Response/RefundHistoryResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Response;
 5 | 
 6 | use Generator;
 7 | use Readdle\AppStoreServerAPI\Exception\HTTPRequestAborted;
 8 | use Readdle\AppStoreServerAPI\Exception\HTTPRequestFailed;
 9 | use Readdle\AppStoreServerAPI\Exception\MalformedJWTException;
10 | use Readdle\AppStoreServerAPI\Exception\MalformedResponseException;
11 | use Readdle\AppStoreServerAPI\Exception\UnimplementedContentTypeException;
12 | use Readdle\AppStoreServerAPI\Util\JWT;
13 | use Readdle\AppStoreServerAPI\Request\AbstractRequest;
14 | use Readdle\AppStoreServerAPI\TransactionInfo;
15 | 
16 | /**
17 |  * @method static RefundHistoryResponse createFromString(string $string, AbstractRequest $originalRequest)
18 |  */
19 | final class RefundHistoryResponse extends PageableResponse
20 | {
21 |     /**
22 |      * @throws MalformedJWTException
23 |      */
24 |     protected function __construct(array $properties, AbstractRequest $originalRequest)
25 |     {
26 |         foreach ($properties['signedTransactions'] ?? [] as $signedTransaction) {
27 |             $this->items[] = TransactionInfo::createFromRawTransactionInfo(JWT::parse($signedTransaction));
28 |         }
29 | 
30 |         unset($properties['signedTransactions']);
31 |         parent::__construct($properties, $originalRequest);
32 |     }
33 | 
34 |     /**
35 |      * Returns a Generator which iterates over a list of refunded transactions.
36 |      * The transactions are sorted in ascending order by revocationDate.
37 |      *
38 |      * @return Generator<TransactionInfo>
39 |      *
40 |      * @throws HTTPRequestAborted
41 |      * @throws HTTPRequestFailed
42 |      * @throws MalformedResponseException
43 |      * @throws UnimplementedContentTypeException
44 |      */
45 |     public function getTransactions(): Generator
46 |     {
47 |         return $this->getItems();
48 |     }
49 | }
50 | 


--------------------------------------------------------------------------------
/examples/getTransactionInfo.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | ['api' => $api, 'credentials' => $credentials] = require 'client.php';
 5 | 
 6 | use Readdle\AppStoreServerAPI\Exception\AppStoreServerAPIException;
 7 | 
 8 | try {
 9 |     $transactionInfoResponse = $api->getTransactionInfo($credentials['transactionId']);
10 | } catch (AppStoreServerAPIException $e) {
11 |     exit($e->getMessage());
12 | }
13 | 
14 | $transactionInfo = $transactionInfoResponse->getTransactionInfo();
15 | 
16 | echo "App Account Token: {$transactionInfo->getAppAccountToken()}\n";
17 | echo "Bundle ID: {$transactionInfo->getBundleId()}\n";
18 | echo "Environment: {$transactionInfo->getEnvironment()}\n";
19 | echo "Expires Date: {$transactionInfo->getExpiresDate()}\n";
20 | echo "In-App Ownership Type: {$transactionInfo->getInAppOwnershipType()}\n";
21 | echo "Is Upgraded: {$transactionInfo->getIsUpgraded()}\n";
22 | echo "Offer Identifier: {$transactionInfo->getOfferIdentifier()}\n";
23 | echo "Offer Type: {$transactionInfo->getOfferType()}\n";
24 | echo "Original Purchase Date: {$transactionInfo->getOriginalPurchaseDate()}\n";
25 | echo "Original Transaction ID: {$transactionInfo->getOriginalTransactionId()}\n";
26 | echo "Product ID: {$transactionInfo->getProductId()}\n";
27 | echo "Purchase Date: {$transactionInfo->getPurchaseDate()}\n";
28 | echo "Quantity: {$transactionInfo->getQuantity()}\n";
29 | echo "Revocation Date: {$transactionInfo->getRevocationDate()}\n";
30 | echo "Revocation Reason: {$transactionInfo->getRevocationReason()}\n";
31 | echo "Signed Date: {$transactionInfo->getSignedDate()}\n";
32 | echo "Subscription Group Identifier: {$transactionInfo->getSubscriptionGroupIdentifier()}\n";
33 | echo "Transaction ID: {$transactionInfo->getTransactionId()}\n";
34 | echo "Type: {$transactionInfo->getType()}\n";
35 | echo "Web Order Line Item ID: {$transactionInfo->getWebOrderLineItemId()}\n";
36 | 
37 | echo "\nAs JSON: " . json_encode($transactionInfo) . "\n\n";
38 | 


--------------------------------------------------------------------------------
/src/RequestBody/ExtendRenewalDateRequestBody.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\RequestBody;
 5 | 
 6 | use Exception;
 7 | 
 8 | final class ExtendRenewalDateRequestBody extends AbstractRequestBody
 9 | {
10 |     /**
11 |      * Undeclared; no information provided.
12 |      */
13 |     const EXTEND_REASON_CODE__UNDECLARED = 0;
14 | 
15 |     /**
16 |      * The renewal-date extension is for customer satisfaction.
17 |      */
18 |     const EXTEND_REASON_CODE__CUSTOMER_SATISFACTION = 1;
19 | 
20 |     /**
21 |      * The renewal-date extension is for other reasons.
22 |      */
23 |     const EXTEND_REASON_CODE__OTHER_REASONS = 2;
24 | 
25 |     /**
26 |      * The renewal-date extension is due to a service issue or outage.
27 |      */
28 |     const EXTEND_REASON_CODE__SERVICE_ISSUE_OR_OUTAGE = 3;
29 | 
30 | 
31 |     /**
32 |      * The number of days to extend the subscription renewal date.
33 |      * Maximum Value: 90
34 |      */
35 |     protected int $extendByDays;
36 | 
37 |     /**
38 |      * The reason code for the subscription date extension.
39 |      */
40 |     protected int $extendReasonCode;
41 | 
42 |     /**
43 |      * A string that contains a value you provide to uniquely identify this renewal-date extension request.
44 |      * Maximum Length: 128
45 |      */
46 |     protected string $requestIdentifier;
47 | 
48 |     protected array $requiredFields = ['*'];
49 | 
50 |     /**
51 |      * @throws Exception
52 |      */
53 |     public function __construct(array $params = [])
54 |     {
55 |         parent::__construct($params);
56 | 
57 |         if ($this->extendByDays < 1 || $this->extendByDays > 90) {
58 |             throw new Exception('"extendByDays" should be numeric value in range from 1 to 90');
59 |         }
60 | 
61 |         if (strlen($this->requestIdentifier) > 128) {
62 |             throw new Exception('"requestIdentifier" should be string value with length from 1 to 128');
63 |         }
64 |     }
65 | }
66 | 


--------------------------------------------------------------------------------
/src/Response/OrderLookupResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Response;
 5 | 
 6 | use Readdle\AppStoreServerAPI\Exception\MalformedJWTException;
 7 | use Readdle\AppStoreServerAPI\Util\JWT;
 8 | use Readdle\AppStoreServerAPI\Request\AbstractRequest;
 9 | use Readdle\AppStoreServerAPI\TransactionInfo;
10 | 
11 | /**
12 |  * @method static OrderLookupResponse createFromString(string $string, AbstractRequest $originalRequest)
13 |  */
14 | final class OrderLookupResponse extends AbstractResponse
15 | {
16 |     const STATUS__VALID = 0;
17 |     const STATUS__INVALID = 1;
18 | 
19 |     /**
20 |      * The status that indicates whether the order ID is valid.
21 |      */
22 |     protected int $status;
23 | 
24 |     /**
25 |      * An array of in-app purchase transactions that are part of order.
26 |      *
27 |      * @var array<int, TransactionInfo>
28 |      */
29 |     protected array $transactions = [];
30 | 
31 |     /**
32 |      * @throws MalformedJWTException
33 |      */
34 |     protected function __construct(array $properties, AbstractRequest $originalRequest)
35 |     {
36 |         foreach ($properties['signedTransactions'] ?? [] as $signedTransaction) {
37 |             $this->transactions[] = TransactionInfo::createFromRawTransactionInfo(JWT::parse($signedTransaction));
38 |         }
39 | 
40 |         unset($properties['signedTransactions']);
41 |         parent::__construct($properties, $originalRequest);
42 |     }
43 | 
44 |     /**
45 |      * Returns the status that indicates whether the order ID is valid.
46 |      *
47 |      * @return self::STATUS__*
48 |      */
49 |     public function getStatus(): int
50 |     {
51 |         /** @phpstan-ignore-next-line */
52 |         return $this->status;
53 |     }
54 | 
55 |     /**
56 |      *  Returns an array of in-app purchase transactions that are part of order.
57 |      *
58 |      * @return array<TransactionInfo>
59 |      */
60 |     public function getTransactions(): array
61 |     {
62 |         return $this->transactions;
63 |     }
64 | }
65 | 


--------------------------------------------------------------------------------
/examples/getRefundHistory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | ['api' => $api, 'credentials' => $credentials] = require 'client.php';
 5 | 
 6 | use Readdle\AppStoreServerAPI\Exception\AppStoreServerAPIException;
 7 | 
 8 | try {
 9 |     $refundHistory = $api->getRefundHistory($credentials['transactionId']);
10 |     $transactions = $refundHistory->getTransactions();
11 | } catch (AppStoreServerAPIException $e) {
12 |     exit($e->getMessage());
13 | }
14 | 
15 | echo "Refund history\n\n";
16 | 
17 | foreach ($transactions as $i => $transactionInfo) {
18 |     echo "Transaction Info #$i\n";
19 |     echo "App Account Token: {$transactionInfo->getAppAccountToken()}\n";
20 |     echo "Bundle ID: {$transactionInfo->getBundleId()}\n";
21 |     echo "Environment: {$transactionInfo->getEnvironment()}\n";
22 |     echo "Expires Date: {$transactionInfo->getExpiresDate()}\n";
23 |     echo "In-App Ownership Type: {$transactionInfo->getInAppOwnershipType()}\n";
24 |     echo "Is Upgraded: {$transactionInfo->getIsUpgraded()}\n";
25 |     echo "Offer Identifier: {$transactionInfo->getOfferIdentifier()}\n";
26 |     echo "Offer Type: {$transactionInfo->getOfferType()}\n";
27 |     echo "Original Purchase Date: {$transactionInfo->getOriginalPurchaseDate()}\n";
28 |     echo "Original Transaction ID: {$transactionInfo->getOriginalTransactionId()}\n";
29 |     echo "Product ID: {$transactionInfo->getProductId()}\n";
30 |     echo "Purchase Date: {$transactionInfo->getPurchaseDate()}\n";
31 |     echo "Quantity: {$transactionInfo->getQuantity()}\n";
32 |     echo "Revocation Date: {$transactionInfo->getRevocationDate()}\n";
33 |     echo "Revocation Reason: {$transactionInfo->getRevocationReason()}\n";
34 |     echo "Signed Date: {$transactionInfo->getSignedDate()}\n";
35 |     echo "Subscription Group Identifier: {$transactionInfo->getSubscriptionGroupIdentifier()}\n";
36 |     echo "Transaction ID: {$transactionInfo->getTransactionId()}\n";
37 |     echo "Type: {$transactionInfo->getType()}\n";
38 |     echo "Web Order Line Item ID: {$transactionInfo->getWebOrderLineItemId()}\n";
39 | 
40 |     echo "\nAs JSON: " . json_encode($transactionInfo) . "\n\n";
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Response/ExtendRenewalDateResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Response;
 5 | 
 6 | use Readdle\AppStoreServerAPI\Request\AbstractRequest;
 7 | 
 8 | /**
 9 |  * @method static ExtendRenewalDateResponse createFromString(string $string, AbstractRequest $originalRequest)
10 |  */
11 | final class ExtendRenewalDateResponse extends AbstractResponse
12 | {
13 |     /**
14 |      * The new subscription expiration date of a successful subscription-renewal-date extension.
15 |      */
16 |     protected int $effectiveDate;
17 | 
18 |     /**
19 |      * The original transaction identifier of the subscription that experienced a service interruption.
20 |      */
21 |     protected string $originalTransactionId;
22 | 
23 |     /**
24 |      * A Boolean value that indicates whether the subscription-renewal-date extension succeeded.
25 |      */
26 |     protected bool $success;
27 | 
28 |     /**
29 |      * A unique ID that identifies subscription-purchase events, including subscription renewals, across devices.
30 |      */
31 |     protected string $webOrderLineItemId;
32 | 
33 |     /**
34 |      * Returns the new subscription expiration date of a successful subscription-renewal-date extension.
35 |      */
36 |     public function getEffectiveDate(): int
37 |     {
38 |         return $this->effectiveDate;
39 |     }
40 | 
41 |     /**
42 |      * Returns the original transaction identifier of the subscription that experienced a service interruption.
43 |      */
44 |     public function getOriginalTransactionId(): string
45 |     {
46 |         return $this->originalTransactionId;
47 |     }
48 | 
49 |     /**
50 |      * Returns a Boolean value that indicates whether the subscription-renewal-date extension succeeded.
51 |      */
52 |     public function isSuccess(): bool
53 |     {
54 |         return $this->success;
55 |     }
56 | 
57 |     /**
58 |      * Returns unique ID that identifies subscription-purchase events, including subscription renewals, across devices.
59 |      */
60 |     public function getWebOrderLineItemId(): string
61 |     {
62 |         return $this->webOrderLineItemId;
63 |     }
64 | }
65 | 


--------------------------------------------------------------------------------
/examples/lookUpOrderId.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | ['api' => $api, 'credentials' => $credentials] = require 'client.php';
 5 | 
 6 | if (empty($credentials['orderId'])) {
 7 |     exit('You have to specify orderId in order to look it up');
 8 | }
 9 | 
10 | use Readdle\AppStoreServerAPI\Exception\AppStoreServerAPIException;
11 | 
12 | try {
13 |     $orderLookup = $api->lookUpOrderId($credentials['orderId']);
14 | } catch (AppStoreServerAPIException $e) {
15 |     exit($e->getMessage());
16 | }
17 | 
18 | echo "Order Lookup\n";
19 | echo "Status: {$orderLookup->getStatus()}\n\n";
20 | 
21 | foreach ($orderLookup->getTransactions() as $i => $transactionInfo) {
22 |     echo "Transaction Info #$i\n";
23 |     echo "App Account Token: {$transactionInfo->getAppAccountToken()}\n";
24 |     echo "Bundle ID: {$transactionInfo->getBundleId()}\n";
25 |     echo "Environment: {$transactionInfo->getEnvironment()}\n";
26 |     echo "Expires Date: {$transactionInfo->getExpiresDate()}\n";
27 |     echo "In-App Ownership Type: {$transactionInfo->getInAppOwnershipType()}\n";
28 |     echo "Is Upgraded: {$transactionInfo->getIsUpgraded()}\n";
29 |     echo "Offer Identifier: {$transactionInfo->getOfferIdentifier()}\n";
30 |     echo "Offer Type: {$transactionInfo->getOfferType()}\n";
31 |     echo "Original Purchase Date: {$transactionInfo->getOriginalPurchaseDate()}\n";
32 |     echo "Original Transaction ID: {$transactionInfo->getOriginalTransactionId()}\n";
33 |     echo "Product ID: {$transactionInfo->getProductId()}\n";
34 |     echo "Purchase Date: {$transactionInfo->getPurchaseDate()}\n";
35 |     echo "Quantity: {$transactionInfo->getQuantity()}\n";
36 |     echo "Revocation Date: {$transactionInfo->getRevocationDate()}\n";
37 |     echo "Revocation Reason: {$transactionInfo->getRevocationReason()}\n";
38 |     echo "Signed Date: {$transactionInfo->getSignedDate()}\n";
39 |     echo "Subscription Group Identifier: {$transactionInfo->getSubscriptionGroupIdentifier()}\n";
40 |     echo "Transaction ID: {$transactionInfo->getTransactionId()}\n";
41 |     echo "Type: {$transactionInfo->getType()}\n";
42 |     echo "Web Order Line Item ID: {$transactionInfo->getWebOrderLineItemId()}\n";
43 | 
44 |     echo "\nAs JSON: " . json_encode($transactionInfo) . "\n\n";
45 | }
46 | 


--------------------------------------------------------------------------------
/src/SubscriptionGroupIdentifierItem.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI;
 5 | 
 6 | use JsonSerializable;
 7 | use Readdle\AppStoreServerAPI\Exception\MalformedJWTException;
 8 | 
 9 | final class SubscriptionGroupIdentifierItem implements JsonSerializable
10 | {
11 |     /**
12 |      * The subscription group identifier of the auto-renewable subscriptions in the lastTransactions array.
13 |      */
14 |     private string $subscriptionGroupIdentifier;
15 | 
16 |     /**
17 |      * An array of the most recent transaction information and renewal information for all auto-renewable
18 |      * subscriptions in the subscription group.
19 |      *
20 |      * @var array<LastTransactionsItem>
21 |      */
22 |     private array $lastTransactions;
23 | 
24 |     /**
25 |      * @param array<LastTransactionsItem> $lastTransactions
26 |      */
27 |     private function __construct(string $subscriptionGroupIdentifier, array $lastTransactions)
28 |     {
29 |         $this->subscriptionGroupIdentifier = $subscriptionGroupIdentifier;
30 |         $this->lastTransactions = $lastTransactions;
31 |     }
32 | 
33 |     /**
34 |      * @param array<string, mixed> $rawItem
35 |      *
36 |      * @throws MalformedJWTException
37 |      */
38 |     public static function createFromRawItem(array $rawItem): self
39 |     {
40 |         $lastTransactions = [];
41 | 
42 |         foreach ($rawItem['lastTransactions'] as $rawTransactionItem) {
43 |             $lastTransactions[] = LastTransactionsItem::createFromRawItem($rawTransactionItem);
44 |         }
45 | 
46 |         return new self($rawItem['subscriptionGroupIdentifier'], $lastTransactions);
47 |     }
48 | 
49 |     /**
50 |      * Returns the subscription group identifier of the auto-renewable subscriptions in the lastTransactions array.
51 |      */
52 |     public function getSubscriptionGroupIdentifier(): string
53 |     {
54 |         return $this->subscriptionGroupIdentifier;
55 |     }
56 | 
57 |     /**
58 |      * Returns an array of the most recent transaction information and renewal information for all auto-renewable
59 |      * subscriptions in the subscription group.
60 |      *
61 |      * @return array<LastTransactionsItem>
62 |      */
63 |     public function getLastTransactions(): array
64 |     {
65 |         return $this->lastTransactions;
66 |     }
67 | 
68 |     /**
69 |      * @return array<string, mixed>
70 |      */
71 |     public function jsonSerialize(): array
72 |     {
73 |         return get_object_vars($this);
74 |     }
75 | }
76 | 


--------------------------------------------------------------------------------
/src/Util/Helper.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Util;
 5 | 
 6 | use Generator;
 7 | use function array_key_exists;
 8 | use function base64_decode;
 9 | use function base64_encode;
10 | use function chunk_split;
11 | use function str_repeat;
12 | use function str_replace;
13 | use function strlen;
14 | use function strtr;
15 | use function trim;
16 | 
17 | final class Helper
18 | {
19 |     /**
20 |      * @param array<string, mixed> $input
21 |      * @param array<string, array<string>> $typeCastMap
22 |      */
23 |     public static function arrayTypeCastGenerator(array $input, array $typeCastMap): Generator
24 |     {
25 |         foreach ($typeCastMap as $type => $keys) {
26 |             foreach ($keys as $key) {
27 |                 if (!array_key_exists($key, $input)) {
28 |                     continue;
29 |                 }
30 | 
31 |                 switch ($type) {
32 |                     case 'int':
33 |                         yield $key => (int) $input[$key];
34 |                         break;
35 | 
36 |                     case 'bool':
37 |                         yield $key => (bool) $input[$key];
38 |                         break;
39 | 
40 |                     case 'float':
41 |                         yield $key => (float) $input[$key];
42 |                         break;
43 | 
44 |                     case 'string':
45 |                         yield $key => (string) $input[$key];
46 |                         break;
47 | 
48 |                     default:
49 |                         yield $key => null;
50 |                 }
51 |             }
52 |         }
53 |     }
54 | 
55 |     public static function base64Encode(string $input): string
56 |     {
57 |         return str_replace('=', '', strtr(base64_encode($input), '+/', '-_'));
58 |     }
59 | 
60 |     public static function base64Decode(string $input): string
61 |     {
62 |         $remainder = strlen($input) % 4;
63 | 
64 |         if ($remainder) {
65 |             $input .= str_repeat('=', 4 - $remainder);
66 |         }
67 | 
68 |         return base64_decode(strtr($input, '-_', '+/'));
69 |     }
70 | 
71 |     public static function formatPEM(string $certificate): string
72 |     {
73 |         if (strpos($certificate, "-----BEGIN CERTIFICATE-----\n") !== false) {
74 |             return $certificate;
75 |         }
76 | 
77 |         return join("\n", [
78 |             "-----BEGIN CERTIFICATE-----",
79 |             $certificate,
80 |             "-----END CERTIFICATE-----"
81 |         ]);
82 |     }
83 | 
84 |     public static function toPEM(string $binary): string
85 |     {
86 |         return trim(chunk_split(base64_encode($binary), 64));
87 |     }
88 | }
89 | 


--------------------------------------------------------------------------------
/src/RequestBody/MassExtendRenewalDateRequestBody.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\RequestBody;
 5 | 
 6 | use Exception;
 7 | 
 8 | final class MassExtendRenewalDateRequestBody extends AbstractRequestBody
 9 | {
10 |     /**
11 |      * Undeclared; no information provided.
12 |      */
13 |     const EXTEND_REASON_CODE__UNDECLARED = 0;
14 | 
15 |     /**
16 |      * The renewal-date extension is for customer satisfaction.
17 |      */
18 |     const EXTEND_REASON_CODE__CUSTOMER_SATISFACTION = 1;
19 | 
20 |     /**
21 |      * The renewal-date extension is for other reasons.
22 |      */
23 |     const EXTEND_REASON_CODE__OTHER_REASONS = 2;
24 | 
25 |     /**
26 |      * The renewal-date extension is due to a service issue or outage.
27 |      */
28 |     const EXTEND_REASON_CODE__SERVICE_ISSUE_OR_OUTAGE = 3;
29 | 
30 | 
31 |     /**
32 |      * The number of days to extend the subscription renewal date.
33 |      * Maximum Value: 90
34 |      */
35 |     protected int $extendByDays;
36 | 
37 |     /**
38 |      * The reason code for the subscription date extension.
39 |      */
40 |     protected int $extendReasonCode;
41 | 
42 |     /**
43 |      * The product identifier of the auto-renewable subscription that you’re requesting the renewal-date extension for.
44 |      */
45 |     protected string $productId;
46 | 
47 |     /**
48 |      * A string that contains a value you provide to uniquely identify this renewal-date extension request.
49 |      * Maximum Length: 128
50 |      */
51 |     protected string $requestIdentifier;
52 | 
53 |     /**
54 |      * A list of storefront country codes you provide to limit the storefronts that are eligible to receive the
55 |      * subscription-renewal-date extension. Omit this list to request the subscription-renewal-date extension in
56 |      * all storefronts.
57 |      *
58 |      * Use the ISO 3166-1 Alpha-3 country code representation.
59 |      *
60 |      * @var array<string>
61 |      */
62 |     protected array $storefrontCountryCodes = [];
63 | 
64 |     protected array $requiredFields = ['extendByDays', 'extendReasonCode', 'productId', 'requestIdentifier'];
65 | 
66 |     /**
67 |      * @throws Exception
68 |      */
69 |     public function __construct(array $params = [])
70 |     {
71 |         parent::__construct($params);
72 | 
73 |         if ($this->extendByDays < 1 || $this->extendByDays > 90) {
74 |             throw new Exception('"extendByDays" should be numeric value in range from 1 to 90');
75 |         }
76 | 
77 |         if (strlen($this->requestIdentifier) > 128) {
78 |             throw new Exception('"requestIdentifier" should be string value with length from 1 to 128');
79 |         }
80 |     }
81 | }
82 | 


--------------------------------------------------------------------------------
/src/HTTPRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI;
 5 | 
 6 | use Exception;
 7 | use Readdle\AppStoreServerAPI\Exception\HTTPRequestAborted;
 8 | use Readdle\AppStoreServerAPI\Exception\HTTPRequestFailed;
 9 | use Readdle\AppStoreServerAPI\Exception\JWTCreationException;
10 | use Readdle\AppStoreServerAPI\Exception\UnimplementedContentTypeException;
11 | use Readdle\AppStoreServerAPI\Request\AbstractRequest;
12 | use Readdle\AppStoreServerAPI\Util\JWT;
13 | 
14 | use function file_get_contents;
15 | use function preg_match;
16 | use function reset;
17 | use function stream_context_create;
18 | 
19 | final class HTTPRequest
20 | {
21 |     /**
22 |      * @throws Exception
23 |      * @throws HTTPRequestFailed
24 |      * @throws HTTPRequestAborted
25 |      * @throws UnimplementedContentTypeException
26 |      */
27 |     public static function performRequest(AbstractRequest $request): string
28 |     {
29 |         try {
30 |             $token = JWT::createFrom($request->getKey(), $request->getPayload());
31 |         } catch (JWTCreationException|Exception $e) {
32 |             throw new HTTPRequestAborted('Authorization token could not be generated', $e);
33 |         }
34 | 
35 |         $httpMethod = $request->getHTTPMethod();
36 | 
37 |         $options = [
38 |             'http' => [
39 |                 'method' => $httpMethod,
40 |                 'header' => "Authorization: Bearer $token",
41 |                 'ignore_errors' => true,
42 |             ]
43 |         ];
44 | 
45 |         if (in_array($httpMethod, [AbstractRequest::HTTP_METHOD_POST, AbstractRequest::HTTP_METHOD_PUT])) {
46 |             $body = $request->getBody();
47 | 
48 |             if ($body) {
49 |                 $options['http']['header'] .= "\r\nContent-Type: {$body->getContentType()}";
50 |                 $options['http']['content'] = $body->getEncodedContent();
51 |             }
52 |         }
53 | 
54 |         $url = $request->composeURL();
55 | 
56 |         $response = file_get_contents(
57 |             $url,
58 |             false,
59 |             stream_context_create($options)
60 |         );
61 | 
62 |         if (empty($http_response_header)) {
63 |             throw new HTTPRequestFailed($httpMethod, $url, 'No response headers found, probably empty response');
64 |         }
65 | 
66 |         $statusLine = reset($http_response_header);
67 | 
68 |         if (!preg_match('/^HTTP\/\d\.\d (?<statusCode>\d+) (?<reasonPhrase>[^\n\r]+)$/', $statusLine, $matches)) {
69 |             throw new HTTPRequestFailed($httpMethod, $url, "Wrong Status-Line: $statusLine");
70 |         }
71 | 
72 |         $statusCode = (int) $matches['statusCode'];
73 | 
74 |         if (!in_array($statusCode, [200, 202])) {
75 |             throw new HTTPRequestFailed($httpMethod, $url, $response, $statusCode);
76 |         }
77 | 
78 |         return $response;
79 |     }
80 | }
81 | 


--------------------------------------------------------------------------------
/src/RequestBody/NotificationHistoryRequestBody.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\RequestBody;
 5 | 
 6 | use Readdle\AppStoreServerAPI\ResponseBodyV2;
 7 | 
 8 | final class NotificationHistoryRequestBody extends AbstractRequestBody
 9 | {
10 |     /**
11 |      * The start date of the timespan for the requested App Store Server Notification history records.
12 |      * The startDate needs to precede the endDate.
13 |      * Choose a startDate that's within the past 180 days from the current date.
14 |      */
15 |     protected int $startDate;
16 | 
17 |     /**
18 |      * The end date of the timespan for the requested App Store Server Notification history records.
19 |      * Choose an endDate that's later than the startDate.
20 |      * If you choose an endDate in the future, the endpoint automatically uses the current date as the endDate.
21 |      */
22 |     protected int $endDate;
23 | 
24 |     /**
25 |      * A notification type.
26 |      * Provide this field to limit the notification history records to those with this one notification type.
27 |      *
28 |      * NOTE: Include either the transactionId or the notificationType in your query, but not both.
29 |      *
30 |      * @see ResponseBodyV2::NOTIFICATION_TYPE__*
31 |      */
32 |     protected ?string $notificationType = null;
33 | 
34 |     /**
35 |      * A notification subtype.
36 |      * Provide this field to limit the notification history records to those with this one notification subtype.
37 |      * If you specify a notificationSubtype, you need to also specify its related notificationType.
38 |      *
39 |      * @see ResponseBodyV2::SUBTYPE__*
40 |      */
41 |     protected ?string $notificationSubtype = null;
42 | 
43 |     /**
44 |      * A Boolean value you set to true to request only the notifications that haven’t reached your server successfully.
45 |      * The response also includes notifications that the App Store server is currently retrying to send to your server.
46 |      */
47 |     protected bool $onlyFailures = false;
48 | 
49 |     /**
50 |      * The transaction identifier, which may be an original transaction identifier,
51 |      * of any transaction belonging to the customer.
52 |      * Provide this field to limit the notification history request to this one customer.
53 |      *
54 |      * NOTE: Include either the transactionId or the notificationType in your query, but not both.
55 |      */
56 |     protected ?string $transactionId = null;
57 | 
58 |     public function __construct(array $params = [])
59 |     {
60 |         if (empty($params['startDate'])) {
61 |             $params['startDate'] = (time() - 60 * 60 * 24 * 180) * 1000; // - half a year by default
62 |         }
63 | 
64 |         if (empty($params['endDate'])) {
65 |             $params['endDate'] = time() * 1000;
66 |         }
67 | 
68 |         parent::__construct($params);
69 |     }
70 | }
71 | 


--------------------------------------------------------------------------------
/src/Request/AbstractRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | declare(strict_types=1);
  3 | 
  4 | namespace Readdle\AppStoreServerAPI\Request;
  5 | 
  6 | use Readdle\AppStoreServerAPI\Key;
  7 | use Readdle\AppStoreServerAPI\Payload;
  8 | use Readdle\AppStoreServerAPI\RequestBody\AbstractRequestBody;
  9 | use Readdle\AppStoreServerAPI\RequestQueryParams\AbstractRequestQueryParams;
 10 | 
 11 | use function array_merge;
 12 | use function preg_replace_callback;
 13 | use function trim;
 14 | 
 15 | abstract class AbstractRequest
 16 | {
 17 |     const HTTP_METHOD_GET = 'GET';
 18 |     const HTTP_METHOD_POST = 'POST';
 19 |     const HTTP_METHOD_PUT = 'PUT';
 20 | 
 21 |     protected Key $key;
 22 |     protected Payload $payload;
 23 |     protected ?AbstractRequestQueryParams $queryParams;
 24 |     protected ?AbstractRequestBody $body;
 25 | 
 26 |     /** @var array<string, mixed> */
 27 |     protected array $urlVars = ['baseUrl' => ''];
 28 | 
 29 |     public function __construct(
 30 |         Key $key,
 31 |         Payload $payload,
 32 |         ?AbstractRequestQueryParams $queryParams,
 33 |         ?AbstractRequestBody $body
 34 |     ) {
 35 |         $this->key = $key;
 36 |         $this->payload = $payload;
 37 |         $this->queryParams = $queryParams;
 38 |         $this->body = $body;
 39 |     }
 40 | 
 41 |     public function getKey(): Key
 42 |     {
 43 |         return $this->key;
 44 |     }
 45 | 
 46 |     public function getPayload(): Payload
 47 |     {
 48 |         return $this->payload;
 49 |     }
 50 | 
 51 |     public function getQueryParams(): ?AbstractRequestQueryParams
 52 |     {
 53 |         return $this->queryParams;
 54 |     }
 55 | 
 56 |     public function getBody(): ?AbstractRequestBody
 57 |     {
 58 |         return $this->body;
 59 |     }
 60 | 
 61 |     /**
 62 |      * @return array<string, mixed>
 63 |      */
 64 |     public function getURLVars(): array
 65 |     {
 66 |         return $this->urlVars;
 67 |     }
 68 | 
 69 |     /**
 70 |      * @param array<string, mixed> $urlVars
 71 |      */
 72 |     public function setURLVars(array $urlVars): void
 73 |     {
 74 |         $this->urlVars = array_merge($this->urlVars, $urlVars);
 75 |     }
 76 | 
 77 |     public function composeURL(): string
 78 |     {
 79 |         $tail = '';
 80 | 
 81 |         if ($this->queryParams !== null) {
 82 |             $queryString = $this->queryParams->getQueryString();
 83 | 
 84 |             if (!empty($queryString)) {
 85 |                 $tail = '?' . $queryString;
 86 |             }
 87 |         }
 88 | 
 89 |         return preg_replace_callback(
 90 |             '/{\w+}/',
 91 |             fn ($match) => $this->urlVars[trim($match[0], '{}')] ?? $match[0],
 92 |             $this->getURLPattern()
 93 |         ) . $tail;
 94 |     }
 95 | 
 96 |     abstract public function getHTTPMethod(): string;
 97 | 
 98 |     abstract protected function getURLPattern(): string;
 99 | }
100 | 


--------------------------------------------------------------------------------
/examples/getTransactionHistory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | ['api' => $api, 'credentials' => $credentials] = require 'client.php';
 5 | 
 6 | use Readdle\AppStoreServerAPI\Exception\AppStoreServerAPIException;
 7 | 
 8 | try {
 9 |     $transactionHistory = $api->getTransactionHistory($credentials['transactionId'], ['sort' => 'ASCENDING']);
10 |     $transactions = $transactionHistory->getTransactions();
11 | } catch (AppStoreServerAPIException $e) {
12 |     exit($e->getMessage());
13 | }
14 | 
15 | echo "App Apple ID: {$transactionHistory->getAppAppleId()}\n";
16 | echo "Bundle ID: {$transactionHistory->getBundleId()}\n";
17 | echo "Environment: {$transactionHistory->getEnvironment()}\n";
18 | echo "\n";
19 | 
20 | foreach ($transactions as $i => $transactionInfo) {
21 |     echo "Transaction Info #$i\n";
22 |     echo "App Account Token: {$transactionInfo->getAppAccountToken()}\n";
23 |     echo "Bundle ID: {$transactionInfo->getBundleId()}\n";
24 |     echo "Currency: {$transactionInfo->getCurrency()}\n";
25 |     echo "Environment: {$transactionInfo->getEnvironment()}\n";
26 |     echo "Expires Date: {$transactionInfo->getExpiresDate()}\n";
27 |     echo 'Expires Date UTC: ' . date('Y-m-d H::i:s', intval($transactionInfo->getExpiresDate() / 1000)) . "\n";
28 |     echo "In-App Ownership Type: {$transactionInfo->getInAppOwnershipType()}\n";
29 |     echo "Is Upgraded: {$transactionInfo->getIsUpgraded()}\n";
30 |     echo "Offer Discount Type: {$transactionInfo->getOfferDiscountType()}\n";
31 |     echo "Offer Identifier: {$transactionInfo->getOfferIdentifier()}\n";
32 |     echo "Offer Type: {$transactionInfo->getOfferType()}\n";
33 |     echo "Original Purchase Date: {$transactionInfo->getOriginalPurchaseDate()}\n";
34 |     echo "Original Transaction ID: {$transactionInfo->getOriginalTransactionId()}\n";
35 |     echo "Price: {$transactionInfo->getPrice()}\n";
36 |     echo "Product ID: {$transactionInfo->getProductId()}\n";
37 |     echo "Purchase Date: {$transactionInfo->getPurchaseDate()}\n";
38 |     echo 'Purchase Date UTC: ' . date('Y-m-d H::i:s', intval($transactionInfo->getPurchaseDate() / 1000)) . "\n";
39 |     echo "Quantity: {$transactionInfo->getQuantity()}\n";
40 |     echo "Revocation Date: {$transactionInfo->getRevocationDate()}\n";
41 |     echo 'Revocation Date UTC: ' . ($transactionInfo->getRevocationDate() ? date('Y-m-d H::i:s', intval($transactionInfo->getRevocationDate() / 1000)) : '') . "\n";
42 |     echo "Revocation Reason: {$transactionInfo->getRevocationReason()}\n";
43 |     echo "Signed Date: {$transactionInfo->getSignedDate()}\n";
44 |     echo "Subscription Group Identifier: {$transactionInfo->getSubscriptionGroupIdentifier()}\n";
45 |     echo "Transaction ID: {$transactionInfo->getTransactionId()}\n";
46 |     echo "Type: {$transactionInfo->getType()}\n";
47 |     echo "Web Order Line Item ID: {$transactionInfo->getWebOrderLineItemId()}\n";
48 | 
49 |     echo "\nAs JSON: " . json_encode($transactionInfo) . "\n\n";
50 | }
51 | 


--------------------------------------------------------------------------------
/src/RequestQueryParams/GetTransactionHistoryQueryParams.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\RequestQueryParams;
 5 | 
 6 | final class GetTransactionHistoryQueryParams extends PageableQueryParams
 7 | {
 8 |     const PRODUCT_TYPE__AUTO_RENEWABLE = 'AUTO_RENEWABLE';
 9 |     const PRODUCT_TYPE__NON_RENEWABLE = 'NON_RENEWABLE';
10 |     const PRODUCT_TYPE__CONSUMABLE = 'CONSUMABLE';
11 |     const PRODUCT_TYPE__NON_CONSUMABLE = 'NON_CONSUMABLE';
12 | 
13 |     const SORT__ASCENDING = 'ASCENDING';
14 |     const SORT__DESCENDING = 'DESCENDING';
15 | 
16 |     /**
17 |      * An optional start date of the timespan for the transaction history records you're requesting.
18 |      * The startDate must precede the endDate if you specify both dates.
19 |      * To be included in results, the transaction's purchaseDate must be equal to or greater than the startDate.
20 |      */
21 |     protected int $startDate = 0;
22 | 
23 |     /**
24 |      * An optional end date of the timespan for the transaction history records you're requesting.
25 |      * Choose an endDate that's later than the startDate if you specify both dates.
26 |      * Using an endDate in the future is valid.
27 |      * To be included in results, the transaction's purchaseDate must be less than the endDate.
28 |      */
29 |     protected int $endDate = 0;
30 | 
31 |     /**
32 |      * An optional filter that indicates the product identifier to include in the transaction history.
33 |      * Your query may specify more than one productID.
34 |      *
35 |      * @var array<string>
36 |      */
37 |     protected array $productId = [];
38 | 
39 |     /**
40 |      * An optional filter that indicates the product type to include in the transaction history.
41 |      * Your query may specify more than one productType.
42 |      *
43 |      * @var array<string>
44 |      */
45 |     protected array $productType = [];
46 | 
47 |     /**
48 |      * An optional sort order for the transaction history records.
49 |      * The response sorts the transaction records by their recently modified date.
50 |      * The default value is ASCENDING, so you receive the oldest records first.
51 |      */
52 |     protected string $sort = self::SORT__ASCENDING;
53 | 
54 |     /**
55 |      * An optional filter that indicates the subscription group identifier to include in the transaction history.
56 |      * Your query may specify more than one subscriptionGroupIdentifier.
57 |      *
58 |      * @var array<int>
59 |      */
60 |     protected array $subscriptionGroupIdentifier = [];
61 | 
62 |     /**
63 |      * An optional filter that limits the transaction history by the in-app ownership type.
64 |      */
65 |     protected string $inAppOwnershipType = '';
66 | 
67 |     /**
68 |      * An optional Boolean value that indicates whether the transaction history excludes refunded and revoked transactions.
69 |      * The default value is false.
70 |      */
71 |     protected bool $excludeRevoked = false;
72 | }
73 | 


--------------------------------------------------------------------------------
/src/Response/PageableResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Response;
 5 | 
 6 | use Generator;
 7 | use Readdle\AppStoreServerAPI\Exception\HTTPRequestAborted;
 8 | use Readdle\AppStoreServerAPI\Exception\HTTPRequestFailed;
 9 | use Readdle\AppStoreServerAPI\Exception\MalformedResponseException;
10 | use Readdle\AppStoreServerAPI\Exception\UnimplementedContentTypeException;
11 | use Readdle\AppStoreServerAPI\HTTPRequest;
12 | use Readdle\AppStoreServerAPI\Request\AbstractRequest;
13 | use Readdle\AppStoreServerAPI\RequestQueryParams\PageableQueryParams;
14 | 
15 | use function get_class;
16 | use function is_subclass_of;
17 | 
18 | /**
19 |  * @method static PageableResponse createFromString(string $string, AbstractRequest $originalRequest)
20 |  */
21 | abstract class PageableResponse extends AbstractResponse
22 | {
23 |     /**
24 |      * A Boolean value that indicates whether the App Store has more items than it returns in this response.
25 |      * If the value is true, use the revision token to request the next set of items.
26 |      */
27 |     protected bool $hasMore;
28 | 
29 |     /**
30 |      * A token you use in a query to request the next set of items
31 |      */
32 |     protected string $revision;
33 | 
34 |     /**
35 |      * Reference to the request which represents the next page of response.
36 |      */
37 |     protected ?PageableResponse $nextPage = null;
38 | 
39 |     /**
40 |      * An array of items.
41 |      *
42 |      * @var array<int, mixed>
43 |      */
44 |     protected array $items = [];
45 | 
46 |     /**
47 |      * @throws HTTPRequestAborted
48 |      * @throws HTTPRequestFailed
49 |      * @throws MalformedResponseException
50 |      * @throws UnimplementedContentTypeException
51 |      */
52 |     protected function getItems(): Generator
53 |     {
54 |         $page = $this;
55 | 
56 |         do {
57 |             foreach ($page->items as $item) {
58 |                 yield $item;
59 |             }
60 | 
61 |             if ($page->hasMore) {
62 |                 $queryParams = $page->originalRequest->getQueryParams();
63 | 
64 |                 if (is_subclass_of($queryParams, PageableQueryParams::class)) {
65 |                     $class = get_class($page->originalRequest);
66 |                     $nextRequest = new $class(
67 |                         $page->originalRequest->getKey(),
68 |                         $page->originalRequest->getPayload(),
69 |                         $queryParams->forRevision($page->revision),
70 |                         $page->originalRequest->getBody()
71 |                     );
72 | 
73 |                     $nextRequest->setURLVars($page->originalRequest->getURLVars());
74 |                     $responseText = HTTPRequest::performRequest($nextRequest);
75 |                     $page->nextPage = static::createFromString($responseText, $nextRequest);
76 |                 }
77 |             }
78 | 
79 |             $page = $page->nextPage;
80 |         } while ($page);
81 |     }
82 | }
83 | 


--------------------------------------------------------------------------------
/src/Response/MassExtendRenewalDateStatusResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Response;
 5 | 
 6 | use Readdle\AppStoreServerAPI\Request\AbstractRequest;
 7 | 
 8 | /**
 9 |  * @method static MassExtendRenewalDateStatusResponse createFromString(string $string, AbstractRequest $originalRequest)
10 |  */
11 | final class MassExtendRenewalDateStatusResponse extends AbstractResponse
12 | {
13 |     /**
14 |      * The UUID that represents your request for a subscription-renewal-date extension.
15 |      */
16 |     protected string $requestIdentifier;
17 | 
18 |     /**
19 |      * A Boolean value that’s TRUE to indicate that the App Store completed your request to extend a subscription
20 |      * renewal date for all eligible subscribers.
21 |      * The value is FALSE if the request is in progress.
22 |      */
23 |     protected bool $complete;
24 | 
25 |     /**
26 |      * The date that the App Store completes the request.
27 |      * Appears only if complete is TRUE.
28 |      */
29 |     protected ?int $completeDate = null;
30 | 
31 |     /**
32 |      * The final count of subscribers that fail to receive a subscription-renewal-date extension.
33 |      * Appears only if complete is TRUE.
34 |      */
35 |     protected ?int $failedCount = null;
36 | 
37 |     /**
38 |      * The final count of subscribers that successfully receive a subscription-renewal-date extension.
39 |      * Appears only if complete is TRUE.
40 |      */
41 |     protected ?int $succeededCount = null;
42 | 
43 |     /**
44 |      * Returns the UUID that represents your request for a subscription-renewal-date extension.
45 |      */
46 |     public function getRequestIdentifier(): string
47 |     {
48 |         return $this->requestIdentifier;
49 |     }
50 | 
51 |     /**
52 |      * Returns a Boolean value that’s `true` to indicate that the App Store completed your request to extend
53 |      * a subscription renewal date for all eligible subscribers.
54 |      * The value is `false` if the request is in progress.
55 |      */
56 |     public function isComplete(): bool
57 |     {
58 |         return $this->complete;
59 |     }
60 | 
61 |     /**
62 |      * Returns the date that the App Store completes the request.
63 |      * Returns `null` if complete is `false`.
64 |      */
65 |     public function getCompleteDate(): ?int
66 |     {
67 |         return $this->completeDate;
68 |     }
69 | 
70 |     /**
71 |      * Returns the final count of subscribers that fail to receive a subscription-renewal-date extension.
72 |      * Returns `null` if complete is `false`.
73 |      */
74 |     public function getFailedCount(): ?int
75 |     {
76 |         return $this->failedCount;
77 |     }
78 | 
79 |     /**
80 |      * Returns the final count of subscribers that successfully receive a subscription-renewal-date extension.
81 |      * Returns `null` if complete is `false`.
82 |      */
83 |     public function getSucceededCount(): ?int
84 |     {
85 |         return $this->succeededCount;
86 |     }
87 | }
88 | 


--------------------------------------------------------------------------------
/src/Response/StatusResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Response;
 5 | 
 6 | use Readdle\AppStoreServerAPI\Environment;
 7 | use Readdle\AppStoreServerAPI\Exception\MalformedJWTException;
 8 | use Readdle\AppStoreServerAPI\Request\AbstractRequest;
 9 | use Readdle\AppStoreServerAPI\SubscriptionGroupIdentifierItem;
10 | 
11 | /**
12 |  * @method static StatusResponse createFromString(string $string, AbstractRequest $originalRequest)
13 |  */
14 | final class StatusResponse extends AbstractResponse
15 | {
16 |     /**
17 |      * The app's identifier in the App Store.
18 |      * This property is available for apps that are downloaded from the App Store; it isn't present in the sandbox
19 |      * environment.
20 |      */
21 |     protected ?int $appAppleId = null;
22 | 
23 |     /**
24 |      * The bundle identifier of the app.
25 |      */
26 |     protected string $bundleId;
27 | 
28 |     /**
29 |      * The server environment in which you're making the request, whether sandbox or production.
30 |      */
31 |     protected string $environment;
32 | 
33 |     /**
34 |      * An array of information for auto-renewable subscriptions,
35 |      * including transaction information and renewal information.
36 |      *
37 |      * @var array<SubscriptionGroupIdentifierItem>
38 |      */
39 |     protected array $data = [];
40 | 
41 |     /**
42 |      * @param array<string, mixed> $properties
43 |      *
44 |      * @throws MalformedJWTException
45 |      */
46 |     protected function __construct(array $properties, AbstractRequest $originalRequest)
47 |     {
48 |         foreach ($properties['data'] as $rawSubscriptionGroupIdentifierItem) {
49 |             $this->data[] = SubscriptionGroupIdentifierItem::createFromRawItem($rawSubscriptionGroupIdentifierItem);
50 |         }
51 | 
52 |         unset($properties['data']);
53 |         parent::__construct($properties, $originalRequest);
54 |     }
55 | 
56 |     /**
57 |      * Returns the app's identifier in the App Store.
58 |      * This property is available for apps that are downloaded from the App Store; it isn't present in the sandbox
59 |      * environment.
60 |      */
61 |     public function getAppAppleId(): ?int
62 |     {
63 |         return $this->appAppleId;
64 |     }
65 | 
66 |     /**
67 |      * Returns the bundle identifier of the app.
68 |      */
69 |     public function getBundleId(): string
70 |     {
71 |         return $this->bundleId;
72 |     }
73 | 
74 |     /**
75 |      * Returns the server environment in which you're making the request, whether sandbox or production.
76 |      *
77 |      * @return Environment::PRODUCTION|Environment::SANDBOX
78 |      */
79 |     public function getEnvironment(): string
80 |     {
81 |         return $this->environment;
82 |     }
83 | 
84 |     /**
85 |      * Returns an array of information for auto-renewable subscriptions,
86 |      * including transaction information and renewal information.
87 |      *
88 |      * @return array<SubscriptionGroupIdentifierItem>
89 |      */
90 |     public function getData(): array
91 |     {
92 |         return $this->data;
93 |     }
94 | }
95 | 


--------------------------------------------------------------------------------
/src/NotificationHistoryResponseItem.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI;
 5 | 
 6 | use JsonSerializable;
 7 | use Readdle\AppStoreServerAPI\Exception\AppStoreServerNotificationException;
 8 | 
 9 | final class NotificationHistoryResponseItem implements JsonSerializable
10 | {
11 |     /**
12 |      * An array of information the App Store server records for its attempts to send a notification to your server.
13 |      * The maximum number of entries in the array is six.
14 |      *
15 |      * @var array<SendAttemptItem>
16 |      */
17 |     protected array $sendAttempts;
18 | 
19 |     /**
20 |      * The cryptographically signed payload, in JSON Web Signature (JWS) format, containing the original response body
21 |      * of a version 2 notification.
22 |      */
23 |     protected string $signedPayload;
24 | 
25 |     /**
26 |      * The original response body of a version 2 notification.
27 |      */
28 |     protected ?ResponseBodyV2 $responseBodyV2 = null;
29 | 
30 |     /**
31 |      * @param array<SendAttemptItem> $sendAttempts
32 |      */
33 |     private function __construct(array $sendAttempts, string $signedPayload)
34 |     {
35 |         $this->sendAttempts = $sendAttempts;
36 |         $this->signedPayload = $signedPayload;
37 | 
38 |         try {
39 |             $this->responseBodyV2 = ResponseBodyV2::createFromRawNotification("{\"signedPayload\":\"$signedPayload\"}");
40 |         } catch (AppStoreServerNotificationException $e) {
41 |             // nothing to do with this hypothetical situation
42 |         }
43 |     }
44 | 
45 |     /**
46 |      * @param array<string, mixed> $rawItem
47 |      */
48 |     public static function createFromRawItem(array $rawItem): self
49 |     {
50 |         $sendAttempts = [];
51 | 
52 |         foreach ($rawItem['sendAttempts'] as $rawSendAttempt) {
53 |             $sendAttempts[] = SendAttemptItem::createFromRawSendAttempt($rawSendAttempt);
54 |         }
55 | 
56 |         return new self($sendAttempts, $rawItem['signedPayload']);
57 |     }
58 | 
59 |     /**
60 |      * Returns an array of information the App Store server records for its attempts to send a notification to your
61 |      * server.
62 |      * The maximum number of entries in the array is six.
63 |      *
64 |      * @return array<SendAttemptItem>
65 |      */
66 |     public function getSendAttempts(): array
67 |     {
68 |         return $this->sendAttempts;
69 |     }
70 | 
71 |     /**
72 |      * Returns the cryptographically signed payload, in JSON Web Signature (JWS) format, containing the original
73 |      * response body of a version 2 notification.
74 |      */
75 |     public function getSignedPayload(): string
76 |     {
77 |         return $this->signedPayload;
78 |     }
79 | 
80 |     /**
81 |      * Returns the original response body of a version 2 notification.
82 |      */
83 |     public function getResponseBodyV2(): ?ResponseBodyV2
84 |     {
85 |         return $this->responseBodyV2;
86 |     }
87 | 
88 |     /**
89 |      * @return array<string, mixed>
90 |      */
91 |     public function jsonSerialize(): array
92 |     {
93 |         return get_object_vars($this);
94 |     }
95 | }
96 | 


--------------------------------------------------------------------------------
/src/Response/HistoryResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Readdle\AppStoreServerAPI\Response;
 5 | 
 6 | use Generator;
 7 | use Readdle\AppStoreServerAPI\Environment;
 8 | use Readdle\AppStoreServerAPI\Exception\HTTPRequestAborted;
 9 | use Readdle\AppStoreServerAPI\Exception\HTTPRequestFailed;
10 | use Readdle\AppStoreServerAPI\Exception\MalformedJWTException;
11 | use Readdle\AppStoreServerAPI\Exception\MalformedResponseException;
12 | use Readdle\AppStoreServerAPI\Exception\UnimplementedContentTypeException;
13 | use Readdle\AppStoreServerAPI\Util\JWT;
14 | use Readdle\AppStoreServerAPI\Request\AbstractRequest;
15 | use Readdle\AppStoreServerAPI\TransactionInfo;
16 | 
17 | /**
18 |  * @method static HistoryResponse createFromString(string $string, AbstractRequest $originalRequest)
19 |  */
20 | final class HistoryResponse extends PageableResponse
21 | {
22 |     /**
23 |      * The app's identifier in the App Store.
24 |      * This property is available for apps that are downloaded from the App Store; it isn't present in the sandbox
25 |      * environment.
26 |      */
27 |     protected ?int $appAppleId = null;
28 | 
29 |     /**
30 |      * The bundle identifier of the app.
31 |      */
32 |     protected string $bundleId;
33 | 
34 |     /**
35 |      * The server environment in which you're making the request, whether sandbox or production.
36 |      */
37 |     protected string $environment;
38 | 
39 |     /**
40 |      * @throws MalformedJWTException
41 |      */
42 |     protected function __construct(array $properties, AbstractRequest $originalRequest)
43 |     {
44 |         foreach ($properties['signedTransactions'] ?? [] as $signedTransactionInfo) {
45 |             $this->items[] = TransactionInfo::createFromRawTransactionInfo(JWT::parse($signedTransactionInfo));
46 |         }
47 | 
48 |         unset($properties['signedTransactions']);
49 |         parent::__construct($properties, $originalRequest);
50 |     }
51 | 
52 |     /**
53 |      * Returns the app's identifier in the App Store.
54 |      * This property is available for apps that are downloaded from the App Store; it isn't present in the sandbox
55 |      * environment.
56 |      */
57 |     public function getAppAppleId(): ?int
58 |     {
59 |         return $this->appAppleId;
60 |     }
61 | 
62 |     /**
63 |      * Returns the bundle identifier of the app.
64 |      */
65 |     public function getBundleId(): string
66 |     {
67 |         return $this->bundleId;
68 |     }
69 | 
70 |     /**
71 |      * Returns the server environment in which you're making the request, whether sandbox or production.
72 |      *
73 |      * @return Environment::PRODUCTION|Environment::SANDBOX
74 |      */
75 |     public function getEnvironment(): string
76 |     {
77 |         return $this->environment;
78 |     }
79 | 
80 |     /**
81 |      * Returns a Generator which iterates over an array of in-app purchase transactions for the customer.
82 |      *
83 |      * @return Generator<TransactionInfo>
84 |      *
85 |      * @throws HTTPRequestAborted
86 |      * @throws HTTPRequestFailed
87 |      * @throws MalformedResponseException
88 |      * @throws UnimplementedContentTypeException
89 |      */
90 |     public function getTransactions(): Generator
91 |     {
92 |         return $this->getItems();
93 |     }
94 | }
95 | 


--------------------------------------------------------------------------------
/src/LastTransactionsItem.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | declare(strict_types=1);
  3 | 
  4 | namespace Readdle\AppStoreServerAPI;
  5 | 
  6 | use JsonSerializable;
  7 | use Readdle\AppStoreServerAPI\Exception\MalformedJWTException;
  8 | use Readdle\AppStoreServerAPI\Util\JWT;
  9 | 
 10 | final class LastTransactionsItem implements JsonSerializable
 11 | {
 12 |     /**
 13 |      * The auto-renewable subscription is active
 14 |      */
 15 |     const STATUS__ACTIVE = 1;
 16 | 
 17 |     /**
 18 |      * The auto-renewable subscription is expired
 19 |      */
 20 |     const STATUS__EXPIRED = 2;
 21 | 
 22 |     /**
 23 |      * The auto-renewable subscription is in a billing retry period
 24 |      */
 25 |     const STATUS__IN_BILLING_RETRY_PERIOD = 3;
 26 | 
 27 |     /**
 28 |      * The auto-renewable subscription is in a Billing Grace Period
 29 |      */
 30 |     const STATUS__IN_BILLING_GRACE_PERIOD = 4;
 31 | 
 32 |     /**
 33 |      * The auto-renewable subscription is revoked
 34 |      */
 35 |     const STATUS__REVOKED = 5;
 36 | 
 37 |     /**
 38 |      * The original transaction identifier of the auto-renewable subscription.
 39 |      */
 40 |     private string $originalTransactionId;
 41 | 
 42 |     /**
 43 |      * The status of the auto-renewable subscription.
 44 |      */
 45 |     private int $status;
 46 | 
 47 |     /**
 48 |      * The subscription renewal information.
 49 |      */
 50 |     private RenewalInfo $renewalInfo;
 51 | 
 52 |     /**
 53 |      * The transaction information.
 54 |      */
 55 |     private TransactionInfo $transactionInfo;
 56 | 
 57 |     private function __construct(
 58 |         string $originalTransactionId,
 59 |         int $status,
 60 |         RenewalInfo $renewalInfo,
 61 |         TransactionInfo $transactionInfo
 62 |     ) {
 63 |         $this->originalTransactionId = $originalTransactionId;
 64 |         $this->status = $status;
 65 |         $this->renewalInfo = $renewalInfo;
 66 |         $this->transactionInfo = $transactionInfo;
 67 |     }
 68 | 
 69 |     /**
 70 |      * @param array<string, int|string> $rawItem
 71 |      *
 72 |      * @throws MalformedJWTException
 73 |      */
 74 |     public static function createFromRawItem(array $rawItem): self
 75 |     {
 76 |         $renewalInfo = RenewalInfo::createFromRawRenewalInfo(JWT::parse($rawItem['signedRenewalInfo']));
 77 |         $transactionInfo = TransactionInfo::createFromRawTransactionInfo(JWT::parse($rawItem['signedTransactionInfo']));
 78 |         return new self($rawItem['originalTransactionId'], $rawItem['status'], $renewalInfo, $transactionInfo);
 79 |     }
 80 | 
 81 |     /**
 82 |      * Returns the original transaction identifier of the auto-renewable subscription.
 83 |      */
 84 |     public function getOriginalTransactionId(): string
 85 |     {
 86 |         return $this->originalTransactionId;
 87 |     }
 88 | 
 89 |     /**
 90 |      * Returns the status of the auto-renewable subscription.
 91 |      *
 92 |      * @return self::STATUS__*
 93 |      */
 94 |     public function getStatus(): int
 95 |     {
 96 |         /** @phpstan-ignore-next-line */
 97 |         return $this->status;
 98 |     }
 99 | 
100 |     /**
101 |      * Returns the subscription renewal information.
102 |      */
103 |     public function getRenewalInfo(): RenewalInfo
104 |     {
105 |         return $this->renewalInfo;
106 |     }
107 | 
108 |     /**
109 |      * Returns the transaction information.
110 |      */
111 |     public function getTransactionInfo(): TransactionInfo
112 |     {
113 |         return $this->transactionInfo;
114 |     }
115 | 
116 |     /**
117 |      * @return array<string, mixed>
118 |      */
119 |     public function jsonSerialize(): array
120 |     {
121 |         return get_object_vars($this);
122 |     }
123 | }
124 | 


--------------------------------------------------------------------------------
/src/Util/ASN1SequenceOfInteger.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | declare(strict_types=1);
  3 | 
  4 | namespace Readdle\AppStoreServerAPI\Util;
  5 | 
  6 | use Exception;
  7 | 
  8 | final class ASN1SequenceOfInteger
  9 | {
 10 |     const ASN1_INTEGER = 0x02;
 11 |     const ASN1_SEQUENCE_IDENTIFIER = 0x10;
 12 |     const ASN1_CONSTRUCTED = 0x20;
 13 | 
 14 |     const ASN1_BIG_INT_MAX_FIRST_BYTE = 0x7F;
 15 | 
 16 |     /**
 17 |      * @throws Exception
 18 |      */
 19 |     public static function toHex(string $asn1): string
 20 |     {
 21 |         $position = 0;
 22 | 
 23 |         if (ord($asn1[$position++]) !== (self::ASN1_CONSTRUCTED | self::ASN1_SEQUENCE_IDENTIFIER)) {
 24 |             throw new Exception('ASN1SequenceOfIntegerReader error: not a sequence');
 25 |         }
 26 | 
 27 |         if (ord($asn1[$position++]) !== strlen($asn1) - 2) {
 28 |             throw new Exception('ASN1SequenceOfIntegerReader error: incorrect sequence length');
 29 |         }
 30 | 
 31 |         $hexParts = [];
 32 |         $asn1Length = strlen($asn1);
 33 | 
 34 |         do {
 35 |             if (ord($asn1[$position++]) !== self::ASN1_INTEGER) {
 36 |                 throw new Exception('ASN1SequenceOfIntegerReader error: entry is not an integer');
 37 |             }
 38 | 
 39 |             $length = ord($asn1[$position++]);
 40 | 
 41 |             if (ord($asn1[$position]) === 0) {
 42 |                 $position++;
 43 |                 $length--;
 44 |             }
 45 | 
 46 |             $bytesArray = str_split(substr($asn1, $position, $length));
 47 | 
 48 |             if (ord($bytesArray[0]) === 0 && ord($bytesArray[1]) > self::ASN1_BIG_INT_MAX_FIRST_BYTE) {
 49 |                 array_shift($bytesArray);
 50 |             }
 51 | 
 52 |             $hexParts[] = join(array_map(
 53 |                 fn (string $chr) => str_pad(dechex(ord($chr)), 2, '0', STR_PAD_LEFT),
 54 |                 $bytesArray
 55 |             ));
 56 | 
 57 |             $position += $length;
 58 |         } while ($position < $asn1Length);
 59 | 
 60 |         $maxLength = array_reduce($hexParts, fn (int $carry, string $item) => max($carry, strlen($item)), 0);
 61 |         return join(array_map(fn (string $hex) => str_pad($hex, $maxLength, '0', STR_PAD_LEFT), $hexParts));
 62 |     }
 63 | 
 64 |     /**
 65 |      * @throws Exception
 66 |      */
 67 |     public static function fromHex(string $hexSignature): string
 68 |     {
 69 |         $length = strlen($hexSignature);
 70 | 
 71 |         if ($length % 2) {
 72 |             throw new Exception('Invalid signature length');
 73 |         }
 74 | 
 75 |         $hexParts = str_split($hexSignature, $length / 2);
 76 | 
 77 |         foreach ($hexParts as &$hexPart) {
 78 |             $firstByteHex = substr($hexPart, 0, 2);
 79 | 
 80 |             if (hexdec($firstByteHex) > self::ASN1_BIG_INT_MAX_FIRST_BYTE) {
 81 |                 $hexPart = '00' . $hexPart;
 82 |             } else {
 83 |                 while ($firstByteHex === '00' && hexdec(substr($hexPart, 2, 2)) <= self::ASN1_BIG_INT_MAX_FIRST_BYTE) {
 84 |                     $hexPart = substr($hexPart, 2);
 85 |                     $firstByteHex = substr($hexPart, 0, 2);
 86 |                 }
 87 |             }
 88 |         }
 89 | 
 90 |         $encodedIntegers = join(array_map(
 91 |             fn (string $hexPart) => join([
 92 |                 chr(self::ASN1_INTEGER),
 93 |                 chr(strlen($hexPart) / 2),
 94 |                 join(array_map(fn (string $hex) => chr(hexdec($hex)), str_split($hexPart, 2))),
 95 |             ]),
 96 |             $hexParts
 97 |         ));
 98 | 
 99 |         return join([
100 |             chr(self::ASN1_CONSTRUCTED | self::ASN1_SEQUENCE_IDENTIFIER),
101 |             chr(strlen($encodedIntegers)),
102 |             $encodedIntegers,
103 |         ]);
104 |     }
105 | }
106 | 


--------------------------------------------------------------------------------
/examples/getAllSubscriptionStatuses.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | ['api' => $api, 'credentials' => $credentials] = require 'client.php';
 5 | 
 6 | use Readdle\AppStoreServerAPI\Exception\AppStoreServerAPIException;
 7 | 
 8 | try {
 9 |     $allSubscriptionStatuses = $api->getAllSubscriptionStatuses($credentials['transactionId']);
10 | } catch (AppStoreServerAPIException $e) {
11 |     exit($e->getMessage());
12 | }
13 | 
14 | echo "App Apple ID: {$allSubscriptionStatuses->getAppAppleId()}\n";
15 | echo "Bundle ID: {$allSubscriptionStatuses->getBundleId()}\n";
16 | echo "Environment: {$allSubscriptionStatuses->getEnvironment()}\n";
17 | echo "\n";
18 | 
19 | foreach ($allSubscriptionStatuses->getData() as $subscriptionGroupIdentifierItem) {
20 |     echo "Subscription Group Identifier: {$subscriptionGroupIdentifierItem->getSubscriptionGroupIdentifier()}\n";
21 |     echo "Last Transactions\n";
22 | 
23 |     foreach ($subscriptionGroupIdentifierItem->getLastTransactions() as $i => $lastTransactionsItem) {
24 |         echo "Original Transaction ID: {$lastTransactionsItem->getOriginalTransactionId()}\n";
25 |         echo "Status: {$lastTransactionsItem->getStatus()}\n";
26 | 
27 |         $transactionInfo = $lastTransactionsItem->getTransactionInfo();
28 |         echo "\nTransaction Info\n";
29 |         echo "App Account Token: {$transactionInfo->getAppAccountToken()}\n";
30 |         echo "Bundle ID: {$transactionInfo->getBundleId()}\n";
31 |         echo "Environment: {$transactionInfo->getEnvironment()}\n";
32 |         echo "Expires Date: {$transactionInfo->getExpiresDate()}\n";
33 |         echo "In-App Ownership Type: {$transactionInfo->getInAppOwnershipType()}\n";
34 |         echo "Is Upgraded: {$transactionInfo->getIsUpgraded()}\n";
35 |         echo "Offer Identifier: {$transactionInfo->getOfferIdentifier()}\n";
36 |         echo "Offer Type: {$transactionInfo->getOfferType()}\n";
37 |         echo "Original Purchase Date: {$transactionInfo->getOriginalPurchaseDate()}\n";
38 |         echo "Original Transaction ID: {$transactionInfo->getOriginalTransactionId()}\n";
39 |         echo "Product ID: {$transactionInfo->getProductId()}\n";
40 |         echo "Purchase Date: {$transactionInfo->getPurchaseDate()}\n";
41 |         echo "Quantity: {$transactionInfo->getQuantity()}\n";
42 |         echo "Revocation Date: {$transactionInfo->getRevocationDate()}\n";
43 |         echo "Revocation Reason: {$transactionInfo->getRevocationReason()}\n";
44 |         echo "Signed Date: {$transactionInfo->getSignedDate()}\n";
45 |         echo "Subscription Group Identifier: {$transactionInfo->getSubscriptionGroupIdentifier()}\n";
46 |         echo "Transaction ID: {$transactionInfo->getTransactionId()}\n";
47 |         echo "Type: {$transactionInfo->getType()}\n";
48 |         echo "Web Order Line Item ID: {$transactionInfo->getWebOrderLineItemId()}\n";
49 | 
50 |         echo "\nAs JSON: " . json_encode($transactionInfo) . "\n";
51 | 
52 |         $renewalInfo = $lastTransactionsItem->getRenewalInfo();
53 |         echo "\nRenewal Info\n";
54 |         echo "Auto Renew Product ID: {$renewalInfo->getAutoRenewProductId()}\n";
55 |         echo "Auto Renew Status: {$renewalInfo->getAutoRenewStatus()}\n";
56 |         echo "Environment: {$renewalInfo->getEnvironment()}\n";
57 |         echo "Expiration Intent: {$renewalInfo->getExpirationIntent()}\n";
58 |         echo "Grace Period Expires Date: {$renewalInfo->getGracePeriodExpiresDate()}\n";
59 |         echo "Is In Billing Retry Period: {$renewalInfo->getIsInBillingRetryPeriod()}\n";
60 |         echo "Offer Identifier: {$renewalInfo->getOfferIdentifier()}\n";
61 |         echo "Offer Type: {$renewalInfo->getOfferType()}\n";
62 |         echo "Original Transaction ID: {$renewalInfo->getOriginalTransactionId()}\n";
63 |         echo "Price Increase Status: {$renewalInfo->getPriceIncreaseStatus()}\n";
64 |         echo "Product ID: {$renewalInfo->getProductId()}\n";
65 |         echo "Recent Subscription Start Date: {$renewalInfo->getRecentSubscriptionStartDate()}\n";
66 |         echo "Signed Date: {$renewalInfo->getSignedDate()}\n";
67 | 
68 |         echo "\nAs JSON: " . json_encode($renewalInfo) . "\n";
69 |     }
70 | }
71 | 


--------------------------------------------------------------------------------
/src/SendAttemptItem.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | declare(strict_types=1);
  3 | 
  4 | namespace Readdle\AppStoreServerAPI;
  5 | 
  6 | use JsonSerializable;
  7 | 
  8 | final class SendAttemptItem implements JsonSerializable
  9 | {
 10 |     /**
 11 |      * The App Store server received a success response when it sent the notification to your server.
 12 |      */
 13 |     const SEND_ATTEMPT_RESULT__SUCCESS = 'SUCCESS';
 14 | 
 15 |     /**
 16 |      * The App Store server detected a continual redirect. Check your server's redirects for a circular redirect loop.
 17 |      */
 18 |     const SEND_ATTEMPT_RESULT__CIRCULAR_REDIRECT = 'CIRCULAR_REDIRECT';
 19 | 
 20 |     /**
 21 |      * The App Store server received an invalid response from your server.
 22 |      */
 23 |     const SEND_ATTEMPT_RESULT__INVALID_RESPONSE = 'INVALID_RESPONSE';
 24 | 
 25 |     /**
 26 |      * The App Store server didn't receive a valid HTTP response from your server.
 27 |      */
 28 |     const SEND_ATTEMPT_RESULT__NO_RESPONSE = 'NO_RESPONSE';
 29 | 
 30 |     /**
 31 |      * Another error occurred that prevented your server from receiving the notification.
 32 |      */
 33 |     const SEND_ATTEMPT_RESULT__OTHER = 'OTHER';
 34 | 
 35 |     /**
 36 |      * The App Store server's connection to your server was closed while send was in progress.
 37 |      */
 38 |     const SEND_ATTEMPT_RESULT__PREMATURE_CLOSE = 'PREMATURE_CLOSE';
 39 | 
 40 |     /**
 41 |      * A network error caused the notification attempt to fail.
 42 |      */
 43 |     const SEND_ATTEMPT_RESULT__SOCKET_ISSUE = 'SOCKET_ISSUE';
 44 | 
 45 |     /**
 46 |      * The App Store server didn't get a response from your server and timed out.
 47 |      * Check that your server isn't processing messages in line.
 48 |      */
 49 |     const SEND_ATTEMPT_RESULT__TIMED_OUT = 'TIMED_OUT';
 50 | 
 51 |     /**
 52 |      * The App Store server couldn't establish a TLS session or validate your certificate.
 53 |      * Check that your server has a valid certificate and supports Transport Layer Security (TLS) protocol 1.2 or later.
 54 |      */
 55 |     const SEND_ATTEMPT_RESULT__TLS_ISSUE = 'TLS_ISSUE';
 56 | 
 57 |     /**
 58 |      * The App Store server didn't receive an HTTP 200 response from your server.
 59 |      */
 60 |     const SEND_ATTEMPT_RESULT__UNSUCCESSFUL_HTTP_RESPONSE_CODE = 'UNSUCCESSFUL_HTTP_RESPONSE_CODE';
 61 | 
 62 |     /**
 63 |      * The App Store server doesn't support the supplied charset.
 64 |      */
 65 |     const SEND_ATTEMPT_RESULT__UNSUPPORTED_CHARSET = 'UNSUPPORTED_CHARSET';
 66 | 
 67 |     /**
 68 |      * The date the App Store server attempts to send the notification.
 69 |      */
 70 |     private int $attemptDate;
 71 | 
 72 |     /**
 73 |      * The success or error information the App Store server records when
 74 |      * it attempts to send an App Store server notification to your server.
 75 |      */
 76 |     private string $sendAttemptResult;
 77 | 
 78 |     private function __construct(int $attemptDate, string $sendAttemptResult)
 79 |     {
 80 |         $this->attemptDate = $attemptDate;
 81 |         $this->sendAttemptResult = $sendAttemptResult;
 82 |     }
 83 | 
 84 |     /**
 85 |      * @param array<string, int|string> $rawSendAttempt
 86 |      */
 87 |     public static function createFromRawSendAttempt(array $rawSendAttempt): self
 88 |     {
 89 |         return new self($rawSendAttempt['attemptDate'], $rawSendAttempt['sendAttemptResult']);
 90 |     }
 91 | 
 92 |     /**
 93 |      * Returns the date the App Store server attempts to send the notification.
 94 |      */
 95 |     public function getAttemptDate(): int
 96 |     {
 97 |         return $this->attemptDate;
 98 |     }
 99 | 
100 |     /**
101 |      * Returns the success or error information the App Store server records when
102 |      * it attempts to send an App Store server notification to your server.
103 |      *
104 |      * @return self::SEND_ATTEMPT_RESULT__*
105 |      */
106 |     public function getSendAttemptResult(): string
107 |     {
108 |         return $this->sendAttemptResult;
109 |     }
110 | 
111 |     /**
112 |      * @return array<string, mixed>
113 |      */
114 |     public function jsonSerialize(): array
115 |     {
116 |         return get_object_vars($this);
117 |     }
118 | }
119 | 


--------------------------------------------------------------------------------
/examples/serverNotificationV2.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | require_once '../vendor/autoload.php';
 5 | 
 6 | use Readdle\AppStoreServerAPI\Exception\AppStoreServerNotificationException;
 7 | use Readdle\AppStoreServerAPI\ResponseBodyV2;
 8 | use Readdle\AppStoreServerAPI\Util\Helper;
 9 | 
10 | $filename = 'notification.json';
11 | $notification = file_get_contents($filename);
12 | 
13 | if (!$notification) {
14 |     exit("`$filename` could not be read or is empty");
15 | }
16 | 
17 | try {
18 |     $responseBodyV2 = ResponseBodyV2::createFromRawNotification(
19 |         $notification,
20 |         Helper::toPEM(file_get_contents('https://www.apple.com/certificateauthority/AppleRootCA-G3.cer'))
21 |     );
22 | } catch (AppStoreServerNotificationException $e) {
23 |     exit('Server notification could not be processed: ' . $e->getMessage());
24 | }
25 | 
26 | echo "Notification type: {$responseBodyV2->getNotificationType()}\n";
27 | echo "Notification subtype: {$responseBodyV2->getSubtype()}\n";
28 | echo "Notification UUID: {$responseBodyV2->getNotificationUUID()}\n";
29 | echo "Version: {$responseBodyV2->getVersion()}\n";
30 | echo "Signed date: {$responseBodyV2->getSignedDate()}\n";
31 | 
32 | echo "\nAs JSON: " . json_encode($responseBodyV2) . "\n";
33 | 
34 | $appMetadata = $responseBodyV2->getAppMetadata();
35 | echo "\nApp Metadata\n";
36 | echo "App Apple ID: {$appMetadata->getAppAppleId()}\n";
37 | echo "Bundle ID: {$appMetadata->getBundleId()}\n";
38 | echo "Bundle Version: {$appMetadata->getBundleVersion()}\n";
39 | echo "Environment: {$appMetadata->getEnvironment()}\n";
40 | 
41 | echo "\nAs JSON: " . json_encode($appMetadata) . "\n";
42 | 
43 | $transactionInfo = $appMetadata->getTransactionInfo();
44 | 
45 | if ($transactionInfo) {
46 |     echo "\nTransaction Info\n";
47 |     echo "App Account Token: {$transactionInfo->getAppAccountToken()}\n";
48 |     echo "Bundle ID: {$transactionInfo->getBundleId()}\n";
49 |     echo "Environment: {$transactionInfo->getEnvironment()}\n";
50 |     echo "Expires Date: {$transactionInfo->getExpiresDate()}\n";
51 |     echo "In-App Ownership Type: {$transactionInfo->getInAppOwnershipType()}\n";
52 |     echo "Is Upgraded: {$transactionInfo->getIsUpgraded()}\n";
53 |     echo "Offer Identifier: {$transactionInfo->getOfferIdentifier()}\n";
54 |     echo "Offer Type: {$transactionInfo->getOfferType()}\n";
55 |     echo "Original Purchase Date: {$transactionInfo->getOriginalPurchaseDate()}\n";
56 |     echo "Original Transaction ID: {$transactionInfo->getOriginalTransactionId()}\n";
57 |     echo "Product ID: {$transactionInfo->getProductId()}\n";
58 |     echo "Purchase Date: {$transactionInfo->getPurchaseDate()}\n";
59 |     echo "Quantity: {$transactionInfo->getQuantity()}\n";
60 |     echo "Revocation Date: {$transactionInfo->getRevocationDate()}\n";
61 |     echo "Revocation Reason: {$transactionInfo->getRevocationReason()}\n";
62 |     echo "Signed Date: {$transactionInfo->getSignedDate()}\n";
63 |     echo "Subscription Group Identifier: {$transactionInfo->getSubscriptionGroupIdentifier()}\n";
64 |     echo "Transaction ID: {$transactionInfo->getTransactionId()}\n";
65 |     echo "Type: {$transactionInfo->getType()}\n";
66 |     echo "Web Order Line Item ID: {$transactionInfo->getWebOrderLineItemId()}\n";
67 | 
68 |     echo "\nAs JSON: " . json_encode($transactionInfo) . "\n";
69 | }
70 | 
71 | $renewalInfo = $appMetadata->getRenewalInfo();
72 | 
73 | if ($renewalInfo) {
74 |     echo "\nRenewal Info\n";
75 |     echo "Auto Renew Product ID: {$renewalInfo->getAutoRenewProductId()}\n";
76 |     echo "Auto Renew Status: {$renewalInfo->getAutoRenewStatus()}\n";
77 |     echo "Environment: {$renewalInfo->getEnvironment()}\n";
78 |     echo "Expiration Intent: {$renewalInfo->getExpirationIntent()}\n";
79 |     echo "Grace Period Expires Date: {$renewalInfo->getGracePeriodExpiresDate()}\n";
80 |     echo "Is In Billing Retry Period: {$renewalInfo->getIsInBillingRetryPeriod()}\n";
81 |     echo "Offer Identifier: {$renewalInfo->getOfferIdentifier()}\n";
82 |     echo "Offer Type: {$renewalInfo->getOfferType()}\n";
83 |     echo "Original Transaction ID: {$renewalInfo->getOriginalTransactionId()}\n";
84 |     echo "Price Increase Status: {$renewalInfo->getPriceIncreaseStatus()}\n";
85 |     echo "Product ID: {$renewalInfo->getProductId()}\n";
86 |     echo "Recent Subscription Start Date: {$renewalInfo->getRecentSubscriptionStartDate()}\n";
87 |     echo "Signed Date: {$renewalInfo->getSignedDate()}\n";
88 | 
89 |     echo "\nAs JSON: " . json_encode($renewalInfo) . "\n";
90 | }
91 | 


--------------------------------------------------------------------------------
/src/AppMetadata.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | declare(strict_types=1);
  3 | 
  4 | namespace Readdle\AppStoreServerAPI;
  5 | 
  6 | use JsonSerializable;
  7 | use Readdle\AppStoreServerAPI\Util\Helper;
  8 | 
  9 | use function array_key_exists;
 10 | 
 11 | final class AppMetadata implements JsonSerializable
 12 | {
 13 |     /**
 14 |      * The unique identifier of the app that the notification applies to.
 15 |      *
 16 |      * This property is available for apps that are downloaded from the App Store; it isn't present in the sandbox
 17 |      * environment.
 18 |      */
 19 |     private ?string $appAppleId = null;
 20 | 
 21 |     /**
 22 |      * The bundle identifier of the app.
 23 |      */
 24 |     private ?string $bundleId = null;
 25 | 
 26 |     /**
 27 |      * The version of the build that identifies an iteration of the bundle.
 28 |      */
 29 |     private ?string $bundleVersion = null;
 30 | 
 31 |     /**
 32 |      * The server environment that the notification applies to, either sandbox or production.
 33 |      */
 34 |     private string $environment;
 35 | 
 36 |     /**
 37 |      * Subscription renewal information.
 38 |      */
 39 |     private ?RenewalInfo $renewalInfo = null;
 40 | 
 41 |     /**
 42 |      * Transaction information.
 43 |      */
 44 |     private ?TransactionInfo $transactionInfo = null;
 45 | 
 46 |     /**
 47 |      * The status of an auto-renewable subscription as of the signedDate in the ResponseBodyV2.
 48 |      *
 49 |      * This field appears only for notifications sent for auto-renewable subscriptions.
 50 |      */
 51 |     private ?int $status = null;
 52 | 
 53 |     private function __construct()
 54 |     {
 55 |         // just a stub which prevents this class from direct instantiation
 56 |     }
 57 | 
 58 |     /**
 59 |      * @param array<string, mixed> $rawData
 60 |      */
 61 |     public static function createFromRawData(array $rawData): self
 62 |     {
 63 |         $appMetadata = new self();
 64 |         $typeCaster = Helper::arrayTypeCastGenerator($rawData, [
 65 |             'int' => ['status'],
 66 |             'string' => ['appAppleId', 'bundleId', 'bundleVersion', 'environment'],
 67 |         ]);
 68 | 
 69 |         foreach ($typeCaster as $prop => $value) {
 70 |             $appMetadata->$prop = $value;
 71 |         }
 72 | 
 73 |         if (array_key_exists('renewalInfo', $rawData) && $rawData['renewalInfo'] instanceof RenewalInfo) {
 74 |             $appMetadata->renewalInfo = $rawData['renewalInfo'];
 75 |         }
 76 | 
 77 |         if (array_key_exists('transactionInfo', $rawData) && $rawData['transactionInfo'] instanceof TransactionInfo) {
 78 |             $appMetadata->transactionInfo = $rawData['transactionInfo'];
 79 |         }
 80 | 
 81 |         return $appMetadata;
 82 |     }
 83 | 
 84 |     /**
 85 |      * Returns the unique identifier of the app that the notification applies to.
 86 |      * This property is available for apps that are downloaded from the App Store; it isn't present in the sandbox
 87 |      * environment.
 88 |      */
 89 |     public function getAppAppleId(): ?string
 90 |     {
 91 |         return $this->appAppleId;
 92 |     }
 93 | 
 94 |     /**
 95 |      * Returns the bundle identifier of the app.
 96 |      */
 97 |     public function getBundleId(): ?string
 98 |     {
 99 |         return $this->bundleId;
100 |     }
101 | 
102 |     /**
103 |      * Returns the version of the build that identifies an iteration of the bundle.
104 |      */
105 |     public function getBundleVersion(): ?string
106 |     {
107 |         return $this->bundleVersion;
108 |     }
109 | 
110 |     /**
111 |      * Returns the server environment that the notification applies to, either sandbox or production.
112 |      *
113 |      * @return Environment::PRODUCTION|Environment::SANDBOX
114 |      */
115 |     public function getEnvironment(): string
116 |     {
117 |         return $this->environment;
118 |     }
119 | 
120 |     /**
121 |      * Returns subscription renewal information (if any).
122 |      */
123 |     public function getRenewalInfo(): ?RenewalInfo
124 |     {
125 |         return $this->renewalInfo;
126 |     }
127 | 
128 |     /**
129 |      * Returns transaction information (if any).
130 |      */
131 |     public function getTransactionInfo(): ?TransactionInfo
132 |     {
133 |         return $this->transactionInfo;
134 |     }
135 | 
136 |     /**
137 |      * Returns the status of an auto-renewable subscription as of the signedDate in the ResponseBodyV2.
138 |      */
139 |     public function getStatus(): ?int
140 |     {
141 |         return $this->status;
142 |     }
143 | 
144 |     /**
145 |      * @return array<string, mixed>
146 |      */
147 |     public function jsonSerialize(): array
148 |     {
149 |         return get_object_vars($this);
150 |     }
151 | }
152 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
  1 | ### [3.6.3] 2024-03-25
  2 | 
  3 | **BUGFIX:**
  4 | 
  5 | - Handle empty response headers in case if HTTP request to the API fails (and it fails regularly, kudos to Apple)
  6 | 
  7 | ### [3.6.2] 2024-01-25
  8 | 
  9 | **BUGFIX:**
 10 | 
 11 | - If the certificate string already has a prefix, there is no need to add it
 12 | 
 13 | ### [3.6.1] 2023-12-19
 14 | 
 15 | **BUGFIX:**
 16 | 
 17 | - Treat "202 Accepted" as successful response (App Store returns it on "Send consumption information" request), kudos to @teanooki for pointing this out
 18 | 
 19 | ### [3.6.0] 2023-12-11
 20 | 
 21 | **IMPROVEMENTS:**
 22 | 
 23 | New fields implemented
 24 | - `TransactionInfo`: `price`, `currency`, and `offerDiscountType` from [App Store Server API version 1.10](https://developer.apple.com/documentation/appstoreserverapi/app_store_server_api_changelog#4307459)
 25 | 
 26 | ### [3.5.2] 2023-10-10
 27 | 
 28 | **BUGFIX:**
 29 | 
 30 | - Logic issue in PageableResponse, after fixing syntax issue in `3.5.1`
 31 | 
 32 | ### [3.5.1] 2023-10-05
 33 | 
 34 | **BUGFIX:**
 35 | 
 36 | - Syntax issue in PageableResponse for PHP 7.4, kudos to @JamieSTV
 37 | 
 38 | ### [3.5.0] 2023-09-21
 39 | 
 40 | **IMPROVEMENTS:**
 41 | 
 42 | Missing endpoints added:
 43 | - Send Consumption Information
 44 | - Extend a Subscription Renewal Date
 45 | - Extend Subscription Renewal Dates for All Active Subscribers
 46 | - Get Status of Subscription Renewal Date Extensions
 47 | 
 48 | ### [3.4.1] 2023-09-17
 49 | 
 50 | **BUGFIX:**
 51 | 
 52 | - `TransactionInfo`: `storefront`, `storefrontId`, and `transactionReason` are now nullable and null by default, in order to be compatible with old notifications
 53 | - `RenewalInfo`: `renewalDate` is now null by default, in order to be compatible with old notifications
 54 | - `Response\NotificationHistoryResponse`: `paginationToken` presence in response is now optional
 55 | 
 56 | ### [3.4.0] 2023-09-16
 57 | 
 58 | **IMPROVEMENTS:**
 59 | 
 60 | - New `notificationType`/`subtype` in `ResponseBodyV2`
 61 | 
 62 | ### [3.3.2] 2023-09-16
 63 | 
 64 | **BUGFIX:**
 65 | 
 66 | - ASN1SequenceOfInteger: multiple `00` bytes in the beginning of integer numbers handled when parsing HEX signature representation
 67 | 
 68 | ### [3.3.1] 2023-09-07
 69 | 
 70 | **BUGFIX:**
 71 | 
 72 | - `AppMetadata`: `bundleId`, `bundleVersion`, `renewalInfo`, `transactionInfo` and `status` now are `NULL` by default (to prevent `Typed property ... must not be accessed before initialization` error)
 73 | 
 74 | ### [3.3.0] 2023-09-06
 75 | 
 76 | **IMPROVEMENTS:**
 77 | 
 78 | - New field implemented
 79 |   - `AppMetadata`: `status`
 80 | 
 81 | ### [3.2.0] 2023-09-03
 82 | 
 83 | **IMPROVEMENTS:**
 84 | 
 85 | - New fields implemented
 86 |   - `RenewalInfo`: `renewalDate`
 87 |   - `TransactionInfo`: `storefront`, `storefrontId`, `transactionReason`
 88 | 
 89 | ### [3.1.1] 2023-09-03
 90 | 
 91 | **BUGFIX:**
 92 | 
 93 | - `ResponseBodyV2`: `createFromRawNotification()` fix, now it checks incoming notification to be not only a valid JSON, but also to be an array
 94 | 
 95 | ### [3.1.0] 2023-08-26
 96 | 
 97 | **BUGFIX:**
 98 |  
 99 | - `ASN1SequenceOfInteger`: math fixes
100 | - `StatusResponse`: `data` array initialization with `[]`
101 | 
102 | **IMPROVEMENTS:**
103 | 
104 | - `HTTPRequest`: PUT method added; HTTP method and URL added to `HTTPRequestFailed` exception message
105 | - `JWT`: additional information in exception message
106 | 
107 | ### [3.0.1] 2023-08-23
108 | 
109 | **BUGFIX:**
110 | 
111 | - Math bug fixed in `ASN1SequenceOfInteger`. In rare cases signature was calculated in a wrong way which led to `Wrong signature` exception in `JWT::verifySignature`
112 | 
113 | ### [3.0.0] 2023-08-18
114 | 
115 | ***BREAKING CHANGES:***
116 | 
117 | - Main classes renamed:
118 |   - `APIClient` -> `AppStoreServerAPI`
119 |   - `APIClientInterface` -> `AppStoreServerAPIInterface`
120 |   - `Notification\ResponseBodyV2` -> `ResponseBodyV2`
121 |   - `JWT` -> `Util\JWT`
122 |   - `Request\GetTransactionHistory` -> `Request\GetTransactionHistoryRequest`
123 |   - `Request\RequestTestNotification` -> `Request\RequestTestNotificationRequest`
124 |   - `Request\GetTransactionHistoryQueryParams` -> `RequestQueryParams\GetTransactionHistoryQueryParams`
125 | - Environment consts moved out from all classes to the separate class `Environment`
126 | - `getTransactionHistory()` method signature changed: it no longer expects for QueryParams instance as a second arguments, now it expects array instead
127 | - `AppStoreServerAPI` (previously `APIClient`) constructor signature changed:
128 |   - `$environment` argument type changed from int to string
129 |   - `$keyId` and `$key` arguments swapped
130 | 
131 | **IMPROVEMENTS:**
132 | 
133 | - PHP 7.4 support out of the box ;)
134 | - A lot of new endpoints (see [README](https://github.com/readdle/app-store-server-api/blob/master/README.md))
135 | - Examples for all implemented endpoints (and notification listener)
136 | 


--------------------------------------------------------------------------------
/src/Request/AbstractRequestParamsBag.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | declare(strict_types=1);
  3 | 
  4 | namespace Readdle\AppStoreServerAPI\Request;
  5 | 
  6 | use Error;
  7 | use ReflectionClass;
  8 | use ReflectionNamedType;
  9 | use ReflectionProperty;
 10 | use TypeError;
 11 | use UnexpectedValueException;
 12 | 
 13 | use function array_combine;
 14 | use function array_filter;
 15 | use function array_key_exists;
 16 | use function array_map;
 17 | use function explode;
 18 | use function get_class;
 19 | use function gettype;
 20 | use function in_array;
 21 | use function is_scalar;
 22 | use function join;
 23 | use function lcfirst;
 24 | use function strpos;
 25 | use function strtolower;
 26 | use function ucfirst;
 27 | use function var_export;
 28 | use function vsprintf;
 29 | 
 30 | use const ARRAY_FILTER_USE_KEY;
 31 | 
 32 | abstract class AbstractRequestParamsBag
 33 | {
 34 |     /**
 35 |      * @var array<string>
 36 |      */
 37 |     protected array $requiredFields = [];
 38 | 
 39 |     /**
 40 |      * @param array<string, mixed> $params
 41 |      */
 42 |     public function __construct(array $params = [])
 43 |     {
 44 |         $reflection = new ReflectionClass($this);
 45 | 
 46 |         $protectedProps = array_filter(
 47 |             $reflection->getProperties(),
 48 |             fn ($property) => $property->isProtected() && $property->getName() !== 'requiredFields'
 49 |         );
 50 |         $protectedProps = array_combine(array_map(fn ($p) => $p->getName(), $protectedProps), $protectedProps);
 51 | 
 52 |         $requiredFields = $this->requiredFields;
 53 | 
 54 |         if (in_array('*', $requiredFields)) {
 55 |             $requiredFields = array_keys($protectedProps);
 56 |         }
 57 | 
 58 |         $diff = array_diff($requiredFields, array_keys($params));
 59 | 
 60 |         if ($diff) {
 61 |             throw new Error(vsprintf(
 62 |                 '[%s] Required fields are missing: ["' . join('","', $diff) . '"]',
 63 |                 [get_class($this)]
 64 |             ));
 65 |         }
 66 | 
 67 |         $propConsts  = array_filter(
 68 |             $reflection->getConstants(),
 69 |             fn ($const) => strpos($const, '__') !== false,
 70 |             ARRAY_FILTER_USE_KEY
 71 |         );
 72 | 
 73 |         /** @var array<string, mixed> $propValues */
 74 |         $propValues = [];
 75 | 
 76 |         foreach ($propConsts as $constName => $constValue) {
 77 |             $camelPropName =  lcfirst(join(array_map(
 78 |                 fn ($part) => ucfirst(strtolower($part)),
 79 |                 explode('_', explode('__', $constName)[0])
 80 |             )));
 81 |             $propValues[$camelPropName][] = $constValue;
 82 |         }
 83 | 
 84 |         foreach ($params as $name => $value) {
 85 |             if ($name === 'revision') {
 86 |                 throw new Error(vsprintf('[%s] Revision could not be set as a parameter', [get_class($this)]));
 87 |             }
 88 | 
 89 |             if (!array_key_exists($name, $protectedProps)) {
 90 |                 throw new Error(vsprintf('[%s] Unrecognized parameter "%s"', [get_class($this), $name]));
 91 |             }
 92 | 
 93 |             if (!$this->isValueMatchingPropType($value, $protectedProps[$name])) {
 94 |                 throw new TypeError(vsprintf(
 95 |                     '[%s] Parameter "%s" is of wrong type "%s" ("%s" is expected)',
 96 |                     [get_class($this), $name, gettype($value), $protectedProps[$name]->getType()]
 97 |                 ));
 98 |             }
 99 | 
100 |             if (isset($propValues[$name]) && !$this->isValueMatchingPropValues($value, $propValues[$name])) {
101 |                 throw new UnexpectedValueException(vsprintf(
102 |                     '[%s] Parameter "%s" has wrong value %s',
103 |                     [get_class($this), $name, var_export($value, true)]
104 |                 ));
105 |             }
106 | 
107 |             $this->$name = $value;
108 |         }
109 |     }
110 | 
111 |     /**
112 |      * @param mixed $value
113 |      */
114 |     protected function isValueMatchingPropType($value, ReflectionProperty $prop): bool
115 |     {
116 |         /** @var ReflectionNamedType $propType */
117 |         $propType = $prop->getType();
118 |         $propTypeName = $propType->getName();
119 | 
120 |         switch ($propTypeName) {
121 |             case 'int':
122 |                 $propTypeName = 'integer';
123 |                 break;
124 | 
125 |             case 'bool':
126 |                 $propTypeName = 'boolean';
127 |                 break;
128 |         }
129 | 
130 |         if ($propTypeName === 'array') {
131 |             // we don't know what type of value it should be
132 |             // probably, the following check for value will do the work
133 |             return true;
134 |         }
135 | 
136 |         if (!is_scalar($value)) {
137 |             // if the prop's type is not 'array' the value type should match it and, thus, it can't be not scalar
138 |             return false;
139 |         }
140 | 
141 |         return $propTypeName === gettype($value);
142 |     }
143 | 
144 |     /**
145 |      * @param mixed $value
146 |      * @param array<string, mixed> $propValues
147 |      */
148 |     protected function isValueMatchingPropValues($value, array $propValues): bool
149 |     {
150 |         if (is_scalar($value)) {
151 |             return in_array($value, $propValues);
152 |         }
153 | 
154 |         if (is_array($value)) {
155 |             return !!array_filter($value, fn ($v) => !in_array($v, $propValues));
156 |         }
157 | 
158 |         return false;
159 |     }
160 | 
161 |     /**
162 |      * @return array<string, mixed>
163 |      */
164 |     protected function collectProps(): array
165 |     {
166 |         $props = [];
167 | 
168 |         $reflection = new ReflectionClass($this);
169 |         $protectedProps = array_filter($reflection->getProperties(), fn ($property) => $property->isProtected());
170 | 
171 |         foreach ($protectedProps as $prop) {
172 |             $propName = $prop->getName();
173 |             $value = $this->$propName;
174 |             $defaultValue = $prop->getDeclaringClass()->getDefaultProperties()[$propName] ?? null;
175 | 
176 |             if (!isset($value) || $value === $defaultValue) {
177 |                 continue;
178 |             }
179 | 
180 |             if (is_array($value)) {
181 |                 $props[$propName] = array_merge($props[$propName] ?? [], $value);
182 |             } else {
183 |                 $props[$propName] = $value;
184 |             }
185 |         }
186 | 
187 |         return $props;
188 | 
189 |     }
190 | }
191 | 


--------------------------------------------------------------------------------
/src/AppStoreServerAPIInterface.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | declare(strict_types=1);
  3 | 
  4 | namespace Readdle\AppStoreServerAPI;
  5 | 
  6 | use Readdle\AppStoreServerAPI\Exception\AppStoreServerAPIException;
  7 | use Readdle\AppStoreServerAPI\Response\CheckTestNotificationResponse;
  8 | use Readdle\AppStoreServerAPI\Response\ExtendRenewalDateResponse;
  9 | use Readdle\AppStoreServerAPI\Response\HistoryResponse;
 10 | use Readdle\AppStoreServerAPI\Response\MassExtendRenewalDateResponse;
 11 | use Readdle\AppStoreServerAPI\Response\MassExtendRenewalDateStatusResponse;
 12 | use Readdle\AppStoreServerAPI\Response\NotificationHistoryResponse;
 13 | use Readdle\AppStoreServerAPI\Response\OrderLookupResponse;
 14 | use Readdle\AppStoreServerAPI\Response\RefundHistoryResponse;
 15 | use Readdle\AppStoreServerAPI\Response\SendTestNotificationResponse;
 16 | use Readdle\AppStoreServerAPI\Response\StatusResponse;
 17 | use Readdle\AppStoreServerAPI\Response\TransactionInfoResponse;
 18 | 
 19 | interface AppStoreServerAPIInterface
 20 | {
 21 |     /**
 22 |      * @param string $environment Either Environment::PRODUCTION or Environment::SANDBOX
 23 |      * @param string $issuerId Your issuer ID from the Keys page in App Store Connect (Ex: "57246542-96fe-1a63-e053-0824d011072a")
 24 |      * @param string $bundleId Your app's bundle ID (Ex: “com.example.TestBundleId2021”)
 25 |      * @param string $key The private key associated with the key ID
 26 |      * @param string $keyId Your private key ID from App Store Connect (Ex: 2X9R4HXF34)
 27 |      */
 28 |     public function __construct(string $environment, string $issuerId, string $bundleId, string $keyId, string $key);
 29 | 
 30 |     /**
 31 |      * Get a customer's in-app purchase transaction history for your app
 32 |      *
 33 |      * @param string $transactionId The identifier of a transaction that belongs to the customer, and which may be an
 34 |      * original transaction identifier
 35 |      * @param array<string, mixed> $queryParams [optional] Query Parameters
 36 |      *
 37 |      * @throws AppStoreServerAPIException
 38 |      */
 39 |     public function getTransactionHistory(string $transactionId, array $queryParams = []): HistoryResponse;
 40 | 
 41 |     /**
 42 |      * Get information about a single transaction for your app.
 43 |      *
 44 |      * @param string $transactionId The identifier of a transaction that belongs to the customer, and which may be an
 45 |      * original transaction identifier
 46 |      *
 47 |      * @throws AppStoreServerAPIException
 48 |      */
 49 |     public function getTransactionInfo(string $transactionId): TransactionInfoResponse;
 50 | 
 51 |     /**
 52 |      * Get the statuses for all of a customer's auto-renewable subscriptions in your app.
 53 |      *
 54 |      * @param string $transactionId The identifier of a transaction that belongs to the customer, and which may be an
 55 |      * original transaction identifier
 56 |      * @param array<string, mixed> $queryParams [optional] Query Parameters
 57 |      *
 58 |      * @throws AppStoreServerAPIException
 59 |      */
 60 |     public function getAllSubscriptionStatuses(string $transactionId, array $queryParams = []): StatusResponse;
 61 | 
 62 |     /**
 63 |      * Send consumption information about a consumable in-app purchase to the App Store after your server receives
 64 |      * a consumption request notification.
 65 |      *
 66 |      * @param string $transactionId The transaction identifier for which you’re providing consumption information.
 67 |      * You receive this identifier in the CONSUMPTION_REQUEST notification the App Store sends to your server.
 68 |      * @param array<string, int|string> $requestBody The request body containing consumption information.
 69 |      *
 70 |      * @throws AppStoreServerAPIException
 71 |      */
 72 |     public function sendConsumptionInformation(string $transactionId, array $requestBody): void;
 73 | 
 74 |     /**
 75 |      * Get a customer's in-app purchases from a receipt using the order ID.
 76 |      *
 77 |      * @param string $orderId The order ID for in-app purchases that belong to the customer.
 78 |      *
 79 |      * @throws AppStoreServerAPIException
 80 |      */
 81 |     public function lookUpOrderId(string $orderId): OrderLookupResponse;
 82 | 
 83 |     /**
 84 |      * Get a list of all of a customer's refunded in-app purchases for your app.
 85 |      *
 86 |      * @param string $transactionId The identifier of a transaction that belongs to the customer, and which may be an
 87 |      * original transaction identifier
 88 |      *
 89 |      * @throws AppStoreServerAPIException
 90 |      */
 91 |     public function getRefundHistory(string $transactionId): RefundHistoryResponse;
 92 | 
 93 |     /**
 94 |      * Extends the renewal date of a customer’s active subscription using the original transaction identifier.
 95 |      *
 96 |      * @param string $originalTransactionId The original transaction identifier of the subscription receiving a renewal
 97 |      * date extension.
 98 |      * @param array<string, int|string> $requestBody The request body that contains subscription-renewal-extension
 99 |      * data for an individual subscription.
100 |      *
101 |      * @throws AppStoreServerAPIException
102 |      */
103 |     public function extendSubscriptionRenewalDate(
104 |         string $originalTransactionId,
105 |         array $requestBody
106 |     ): ExtendRenewalDateResponse;
107 | 
108 |     /**
109 |      * Uses a subscription’s product identifier to extend the renewal date for all of its eligible active subscribers.
110 |      *
111 |      * @param array<string, int|string> $requestBody
112 |      *
113 |      * @throws AppStoreServerAPIException
114 |      */
115 |     public function massExtendSubscriptionRenewalDate(array $requestBody): MassExtendRenewalDateResponse;
116 | 
117 |     /**
118 |      * Checks whether a renewal date extension request completed, and provides the final count of successful
119 |      * or failed extensions.
120 |      *
121 |      * @param string $productId The product identifier of the auto-renewable subscription that you request
122 |      * a renewal-date extension for.
123 |      * @param string $requestIdentifier The UUID that represents your request to
124 |      * the massExtendSubscriptionRenewalDate() endpoint.
125 |      *
126 |      * @throws AppStoreServerAPIException
127 |      */
128 |     public function getStatusOfSubscriptionRenewalDateExtensionsRequest(
129 |         string $productId,
130 |         string $requestIdentifier
131 |     ): MassExtendRenewalDateStatusResponse;
132 | 
133 |     /**
134 |      * Get a list of notifications that the App Store server attempted to send to your server.
135 |      *
136 |      * @param array<string, mixed> $requestBody The request body that includes the start and end dates,
137 |      * and optional query constraints.
138 |      *
139 |      * @throws AppStoreServerAPIException
140 |      */
141 |     public function getNotificationHistory(array $requestBody): NotificationHistoryResponse;
142 | 
143 |     /**
144 |      * Ask App Store Server Notifications to send a test notification to your server
145 |      *
146 |      * @throws AppStoreServerAPIException
147 |      */
148 |     public function requestTestNotification(): SendTestNotificationResponse;
149 | 
150 |     /**
151 |      * Check the status of the test App Store server notification sent to your server.
152 |      *
153 |      * @param string $testNotificationToken The token that uniquely identifies a test, that you receive when you call
154 |      * APIClientInterface::requestTestNotification().
155 |      *
156 |      * @throws AppStoreServerAPIException
157 |      */
158 |     public function getTestNotificationStatus(string $testNotificationToken): CheckTestNotificationResponse;
159 | }
160 | 


--------------------------------------------------------------------------------
/src/Util/JWT.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | declare(strict_types=1);
  3 | 
  4 | namespace Readdle\AppStoreServerAPI\Util;
  5 | 
  6 | use Exception;
  7 | use Readdle\AppStoreServerAPI\Exception\JWTCreationException;
  8 | use Readdle\AppStoreServerAPI\Exception\MalformedJWTException;
  9 | use Readdle\AppStoreServerAPI\Key;
 10 | use Readdle\AppStoreServerAPI\Payload;
 11 | 
 12 | use function array_key_exists;
 13 | use function array_map;
 14 | use function count;
 15 | use function explode;
 16 | use function is_null;
 17 | use function join;
 18 | use function json_decode;
 19 | use function json_encode;
 20 | use function json_last_error;
 21 | use function openssl_sign;
 22 | use function openssl_x509_verify;
 23 | use function preg_match;
 24 | use function set_error_handler;
 25 | use function strrpos;
 26 | use function substr;
 27 | use function trim;
 28 | 
 29 | use const OPENSSL_ALGO_SHA256;
 30 | 
 31 | final class JWT
 32 | {
 33 |     const TYPE = 'JWT';
 34 | 
 35 |     const ALGORITHM = [
 36 |         'name' => 'ES256',
 37 |         'opensslAlgorithm' => OPENSSL_ALGO_SHA256,
 38 |         'hashAlgorithm' => 'sha256',
 39 |     ];
 40 | 
 41 |     const HEADER_TYP = 'typ';
 42 |     const HEADER_ALG = 'alg';
 43 |     const HEADER_KID = 'kid';
 44 |     const HEADER_X5C = 'x5c';
 45 | 
 46 |     const REQUIRED_JWT_HEADERS = [
 47 |         self::HEADER_ALG,
 48 |         self::HEADER_X5C,
 49 |     ];
 50 | 
 51 |     private static bool $unsafeMode = false;
 52 | 
 53 |     /**
 54 |      * @throws JWTCreationException
 55 |      * @throws Exception
 56 |      */
 57 |     public static function createFrom(Key $key, Payload $payload): string
 58 |     {
 59 |         $header = [
 60 |             self::HEADER_TYP => self::TYPE,
 61 |             self::HEADER_ALG => self::ALGORITHM['name'],
 62 |             self::HEADER_KID => $key->getKeyId(),
 63 |         ];
 64 | 
 65 |         $segments[] = Helper::base64Encode(json_encode($header));
 66 |         $segments[] = Helper::base64Encode(json_encode($payload->toArray()));
 67 | 
 68 |         $error = null;
 69 |         $errorHandler = function (int $code, string $message) use (&$error): bool {
 70 |             if (preg_match('/^openssl_sign\(\): ([\w\s]+)$/', trim($message), $m)) {
 71 |                 $error = $m[1];
 72 |             }
 73 | 
 74 |             return true;
 75 |         };
 76 | 
 77 |         $previousErrorHandler = set_error_handler($errorHandler);
 78 |         $signatureAsASN1 = '';
 79 |         $isSigned = openssl_sign(
 80 |             join('.', $segments),
 81 |             $signatureAsASN1,
 82 |             $key->getKey(),
 83 |             self::ALGORITHM['opensslAlgorithm']
 84 |         );
 85 |         set_error_handler($previousErrorHandler);
 86 | 
 87 |         if (!$isSigned) {
 88 |             throw new JWTCreationException('Message could not be signed', new Exception($error));
 89 |         }
 90 | 
 91 |         try {
 92 |             $signature = ASN1SequenceOfInteger::toHex($signatureAsASN1);
 93 |         } catch (Exception $e) {
 94 |             throw new JWTCreationException('Signature could not be encoded', $e);
 95 |         }
 96 | 
 97 |         $segments[] = Helper::base64Encode(hex2bin($signature));
 98 |         return join('.', $segments);
 99 |     }
100 | 
101 |     /**
102 |      * WARNING!
103 |      * THIS METHOD TURNS OFF VALIDATION AT ALL!
104 |      * USE IT FOR TESTING PURPOSES ONLY!
105 |      *
106 |      * Turns unsafe mode on/off.
107 |      * Returns previous state of unsafe mode.
108 |      *
109 |      * NOTE: Unsafe mode means that payloads will be parsed without any validation.
110 |      *
111 |      * @noinspection PhpUnused
112 |      */
113 |     public static function unsafeMode(bool $state = true): bool
114 |     {
115 |         $previousState = self::$unsafeMode;
116 |         self::$unsafeMode = $state;
117 |         return $previousState;
118 |     }
119 | 
120 |     /**
121 |      * Parses signed payload, checks its headers, certificates chain, signature.
122 |      * Returns decoded payload.
123 |      * Throws an exception if payload is malformed or verification failed.
124 |      *
125 |      * @return array<string, mixed>
126 |      *
127 |      * @throws MalformedJWTException
128 |      */
129 |     public static function parse(string $jwt, ?string $rootCertificate = null): array
130 |     {
131 |         $parts = explode('.', $jwt);
132 |         $partsCount = count($parts);
133 | 
134 |         if ($partsCount !== 3) {
135 |             throw new MalformedJWTException('Payload should contain 3 parts, ' . $partsCount . ' were found');
136 |         }
137 | 
138 |         [$headersJson, $payloadJson, $signature] = array_map([Helper::class, 'base64Decode'], $parts);
139 | 
140 |         if (!$headersJson || !$payloadJson || !$signature) {
141 |             throw new MalformedJWTException('JWT could not be decoded');
142 |         }
143 | 
144 |         $headers = json_decode($headersJson, true);
145 | 
146 |         if (json_last_error() !== JSON_ERROR_NONE) {
147 |             throw new MalformedJWTException('Headers JSON could not be decoded');
148 |         }
149 | 
150 |         $payload = json_decode($payloadJson, true);
151 | 
152 |         if (json_last_error() !== JSON_ERROR_NONE) {
153 |             throw new MalformedJWTException('Payload JSON could not be decoded');
154 |         }
155 | 
156 |         if (self::$unsafeMode) {
157 |             return $payload;
158 |         }
159 | 
160 |         $missingHeaders = [];
161 | 
162 |         foreach (self::REQUIRED_JWT_HEADERS as $headerName) {
163 |             if (!array_key_exists($headerName, $headers)) {
164 |                 $missingHeaders[] = $headerName;
165 |             }
166 |         }
167 | 
168 |         if ($missingHeaders) {
169 |             throw new MalformedJWTException('Required headers are missing: [' . join(', ', $missingHeaders) . ']');
170 |         }
171 | 
172 |         if ($headers[self::HEADER_ALG] !== self::ALGORITHM['name']) {
173 |             throw new MalformedJWTException('Unrecognized algorithm: ' . $headers[self::HEADER_ALG]);
174 |         }
175 | 
176 |         try {
177 |             self::verifyX509Chain($headers[self::HEADER_X5C], $rootCertificate);
178 |         } catch (Exception $e) {
179 |             throw new MalformedJWTException('Certificate chain could not be verified: ' . $e->getMessage());
180 |         }
181 | 
182 |         $signedPart = substr($jwt, 0, strrpos($jwt, '.'));
183 | 
184 |         try {
185 |             self::verifySignature($headers, $signedPart, $signature);
186 |         } catch (Exception $e) {
187 |             throw new MalformedJWTException('Signature verification failed: ' . $e->getMessage());
188 |         }
189 | 
190 |         return $payload;
191 |     }
192 | 
193 |     /**
194 |      * @param array<int, string> $chain
195 |      *
196 |      * @throws Exception
197 |      */
198 |     private static function verifyX509Chain(array $chain, ?string $rootCertificate = null): void
199 |     {
200 |         [$certificate, $intermediate, $root] = array_map([Helper::class, 'formatPEM'], $chain);
201 | 
202 |         if (openssl_x509_verify($certificate, $intermediate) !== 1) {
203 |             throw new Exception('Certificate verification failed');
204 |         }
205 | 
206 |         if (openssl_x509_verify($intermediate, $root) !== 1) {
207 |             throw new Exception('Intermediate certificate verification failed');
208 |         }
209 | 
210 |         if (
211 |             !is_null($rootCertificate)
212 |             && openssl_x509_verify($root, Helper::formatPEM($rootCertificate)) !== 1
213 |         ) {
214 |             throw new Exception('Root certificate verification failed');
215 |         }
216 |     }
217 | 
218 |     /**
219 |      * @param array<string, string> $headers
220 |      *
221 |      * @throws Exception
222 |      */
223 |     private static function verifySignature(array $headers, string $input, string $signature): void
224 |     {
225 |         $signatureAsASN1 = ASN1SequenceOfInteger::fromHex(bin2hex($signature));
226 |         $publicKey = Helper::formatPEM($headers[self::HEADER_X5C][0]);
227 | 
228 |         if (openssl_verify($input, $signatureAsASN1, $publicKey, self::ALGORITHM['hashAlgorithm']) !== 1) {
229 |             throw new Exception('Wrong signature');
230 |         }
231 |     }
232 | }
233 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # About
  2 | 
  3 | This is a ***zero-dependencies\* pure PHP*** library that allows managing customer transactions using the [`App Store Server API`](https://developer.apple.com/documentation/appstoreserverapi) and handling server-to-server notifications by providing everything you need to implement the [`App Store Server Notifications V2`](https://developer.apple.com/documentation/appstoreservernotifications) endpoint.
  4 | 
  5 | <sub>* Zero-dependencies means this library doesn't rely on any third-party library. At the same time, this library relies on such essential PHP extensions as `json` and `openssl`</sub>
  6 | 
  7 | > **NOTE**
  8 | > 
  9 | > If you need to deal with receipts instead of (or additionally to) API, check out [this library](https://github.com/readdle/app-store-receipt-verification).
 10 | 
 11 | # Installation
 12 | 
 13 | Nothing special here, just use composer to install the package:
 14 | 
 15 | > composer install readdle/app-store-server-api
 16 | 
 17 | # Usage
 18 | 
 19 | ### App Store Server API
 20 | 
 21 | API initialization:
 22 | 
 23 | ```
 24 | try {
 25 |     $api = new \Readdle\AppStoreServerAPI\AppStoreServerAPI(
 26 |         \Readdle\AppStoreServerAPI\Environment::PRODUCTION,
 27 |         '1a2b3c4d-1234-4321-1111-1a2b3c4d5e6f',
 28 |         'com.readdle.MyBundle',
 29 |         'ABC1234DEF',
 30 |         "-----BEGIN PRIVATE KEY-----\n<base64-encoded private key goes here>\n-----END PRIVATE KEY-----"
 31 |     );
 32 | } catch (\Readdle\AppStoreServerAPI\Exception\WrongEnvironmentException $e) {
 33 |     exit($e->getMessage());
 34 | }
 35 | ```
 36 | 
 37 | Performing API call:
 38 | 
 39 | ```
 40 | try {
 41 |     $transactionHistory = $api->getTransactionHistory($transactionId, ['sort' => GetTransactionHistoryQueryParams::SORT__DESCENDING]);
 42 |     $transactions = $transactionHistory->getTransactions();
 43 | } catch (\Readdle\AppStoreServerAPI\Exception\AppStoreServerAPIException $e) {
 44 |     exit($e->getMessage());
 45 | }
 46 | ```
 47 | 
 48 | ### App Store Server Notifications
 49 | 
 50 | ```
 51 | try {
 52 |     $responseBodyV2 = \Readdle\AppStoreServerAPI\ResponseBodyV2::createFromRawNotification(
 53 |         '{"signedPayload":"..."}',
 54 |         \Readdle\AppStoreServerAPI\Util\Helper::toPEM(file_get_contents('https://www.apple.com/certificateauthority/AppleRootCA-G3.cer'))
 55 |     );
 56 | } catch (\Readdle\AppStoreServerAPI\Exception\AppStoreServerNotificationException $e) {
 57 |     exit('Server notification could not be processed: ' . $e->getMessage());
 58 | }
 59 | ```
 60 | 
 61 | # Examples
 62 | 
 63 | In `examples/` directory you can find examples for all implemented endpoints. Initialization of the API client is separated into `client.php` and used in all examples.
 64 | 
 65 | In order to run examples you have to create `credentials.json` and/or `notifications.json` inside `examples/` directory.
 66 | 
 67 | `credentials.json` structure should be as follows:
 68 | 
 69 | ```
 70 | {
 71 |   "env": "Production",
 72 |   "issuerId": "1a2b3c4d-1234-4321-1111-1a2b3c4d5e6f",
 73 |   "bundleId": "com.readdle.MyBundle",
 74 |   "keyId": "ABC1234DEF",
 75 |   "key": "-----BEGIN PRIVATE KEY-----\n<base64-encoded private key goes here>\n-----END PRIVATE KEY-----",
 76 |   "orderId": "ABC1234DEF",
 77 |   "transactionId": "123456789012345"
 78 | }
 79 | ```
 80 | 
 81 | In most examples `transactionId` is used. Please, consider that `transactionId` is related to `environment`, so if you put `transactionId` from the sandbox the `environment` property should be `Sandbox` as well, otherwise you'll get `{"errorCode":4040010,"errorMessage":"Transaction id not found."}` error. 
 82 | 
 83 | For `Order ID lookup` you have to specify `orderId`. This endpoint (and, consequently, the example) is not available in the sandbox environment.
 84 | 
 85 | `notification.json` structure is the same as you receive it in your server-to-server notification endpoint:
 86 | 
 87 | ```
 88 | {"signedPayload":"<JWT token goes here>"}
 89 | ```
 90 | 
 91 | # What is covered
 92 | 
 93 | ### In-app purchase history
 94 | 
 95 | #### [Get Transaction History](https://developer.apple.com/documentation/appstoreserverapi/get_transaction_history)
 96 | 
 97 | `AppStoreServerAPI::getTransactionHistory(string $transactionId, array $queryParams)`
 98 | 
 99 | Get a customer’s in-app purchase transaction history for your app.
100 | 
101 | ### Transaction Info
102 | 
103 | #### [Get Transaction Info](https://developer.apple.com/documentation/appstoreserverapi/get_transaction_info)
104 | 
105 | `AppStoreServerAPI::getTransactionInfo(string $transactionId)`
106 | 
107 | Get information about a single transaction for your app.
108 | 
109 | ### Subscription status
110 | 
111 | #### [Get All Subscription Statuses](https://developer.apple.com/documentation/appstoreserverapi/get_all_subscription_statuses)
112 | 
113 | `AppStoreServerAPI::getAllSubscriptionStatuses(string $transactionId, array $queryParams = [])`
114 | 
115 | Get the statuses for all of a customer’s auto-renewable subscriptions in your app.
116 | 
117 | ### Consumption information
118 | 
119 | #### [Send Consumption Information](https://developer.apple.com/documentation/appstoreserverapi/send_consumption_information)
120 | 
121 | `AppStoreServerAPI::sendConsumptionInformation(string $transactionId, array $requestBody)`
122 | 
123 | Send consumption information about a consumable in-app purchase to the App Store after your server receives a consumption request notification.
124 | 
125 | ### Order ID lookup
126 | 
127 | #### [Look Up Order ID](https://developer.apple.com/documentation/appstoreserverapi/look_up_order_id)
128 | 
129 | `AppStoreServerAPI::lookUpOrderId(string $orderId)`
130 | 
131 | Get a customer’s in-app purchases from a receipt using the order ID.
132 | 
133 | ### Refund lookup
134 | 
135 | #### [Get Refund History](https://developer.apple.com/documentation/appstoreserverapi/get_refund_history)
136 | 
137 | `AppStoreServerAPI::getRefundHistory(string $transactionId)`
138 | 
139 | Get a list of all of a customer’s refunded in-app purchases for your app.
140 | 
141 | ### Subscription-renewal-date extension
142 | 
143 | #### [Extend a Subscription Renewal Date](https://developer.apple.com/documentation/appstoreserverapi/extend_a_subscription_renewal_date)
144 | 
145 | `AppStoreServerAPI::extendSubscriptionRenewalDate(string $originalTransactionId, array $requestBody)`
146 | 
147 | Extends the renewal date of a customer’s active subscription using the original transaction identifier.
148 | 
149 | #### [Extend Subscription Renewal Dates for All Active Subscribers](https://developer.apple.com/documentation/appstoreserverapi/extend_subscription_renewal_dates_for_all_active_subscribers)
150 | 
151 | `AppStoreServerAPI::massExtendSubscriptionRenewalDate(array $requestBody)`
152 | 
153 | Uses a subscription’s product identifier to extend the renewal date for all of its eligible active subscribers.
154 | 
155 | #### [Get Status of Subscription Renewal Date Extensions](https://developer.apple.com/documentation/appstoreserverapi/get_status_of_subscription_renewal_date_extensions)
156 | 
157 | `AppStoreServerAPI::getStatusOfSubscriptionRenewalDateExtensionsRequest(string $productId, string $requestIdentifier)`
158 | 
159 | Checks whether a renewal date extension request completed, and provides the final count of successful or failed extensions.
160 | 
161 | ### App Store Server Notifications history
162 | 
163 | #### [Get Notification History](https://developer.apple.com/documentation/appstoreserverapi/get_notification_history)
164 | 
165 | `AppStoreServerAPI::getNotificationHistory(array $requestBody)`
166 | 
167 | Get a list of notifications that the App Store server attempted to send to your server.
168 | 
169 | ### App Store Server Notifications testing
170 | 
171 | #### [Request a Test Notification](https://developer.apple.com/documentation/appstoreserverapi/request_a_test_notification)
172 | 
173 | `AppStoreServerAPI::requestTestNotification()`
174 | 
175 | Ask App Store Server Notifications to send a test notification to your server.
176 | 
177 | #### [Get Test Notification Status](https://developer.apple.com/documentation/appstoreserverapi/get_test_notification_status)
178 | 
179 | `AppStoreServerAPI::getTestNotificationStatus(string $testNotificationToken)`
180 | 
181 | Check the status of the test App Store server notification sent to your server.
182 | 


--------------------------------------------------------------------------------
/src/RequestBody/ConsumptionRequestBody.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | declare(strict_types=1);
  3 | 
  4 | namespace Readdle\AppStoreServerAPI\RequestBody;
  5 | 
  6 | final class ConsumptionRequestBody extends AbstractRequestBody
  7 | {
  8 |     /**
  9 |      * Account age is undeclared.
 10 |      */
 11 |     const ACCOUNT_TENURE__UNDECLARED = 0;
 12 | 
 13 |     /**
 14 |      * Account age is between 0–3 days.
 15 |      */
 16 |     const ACCOUNT_TENURE__3 = 1;
 17 | 
 18 |     /**
 19 |      * Account age is between 3–10 days.
 20 |      */
 21 |     const ACCOUNT_TENURE__10 = 2;
 22 | 
 23 |     /**
 24 |      * Account age is between 10–30 days.
 25 |      */
 26 |     const ACCOUNT_TENURE__30 = 3;
 27 | 
 28 |     /**
 29 |      * Account age is between 30–90 days.
 30 |      */
 31 |     const ACCOUNT_TENURE__90 = 4;
 32 | 
 33 |     /**
 34 |      * Account age is between 90–180 days.
 35 |      */
 36 |     const ACCOUNT_TENURE__180 = 5;
 37 | 
 38 |     /**
 39 |      * Account age is between 180–365 days.
 40 |      */
 41 |     const ACCOUNT_TENURE__365 = 6;
 42 | 
 43 |     /**
 44 |      * Account age is over 365 days.
 45 |      */
 46 |     const ACCOUNT_TENURE__OVER_365 = 7;
 47 | 
 48 |     /**
 49 |      * The consumption status is undeclared.
 50 |      */
 51 |     const CONSUMPTION_STATUS__UNDECLARED = 0;
 52 | 
 53 |     /**
 54 |      * The in-app purchase is not consumed.
 55 |      */
 56 |     const CONSUMPTION_STATUS__NOT_CONSUMED = 1;
 57 | 
 58 |     /**
 59 |      * The in-app purchase is partially consumed.
 60 |      */
 61 |     const CONSUMPTION_STATUS__PARTIALLY_CONSUMED = 2;
 62 | 
 63 |     /**
 64 |      * The in-app purchase is fully consumed.
 65 |      */
 66 |     const CONSUMPTION_STATUS__FULLY_CONSUMED = 3;
 67 | 
 68 |     /**
 69 |      * The app delivered the consumable in-app purchase, and it’s working properly.
 70 |      */
 71 |     const DELIVERY_STATUS__DELIVERED = 0;
 72 | 
 73 |     /**
 74 |      * The app didn't deliver the consumable in-app purchase due to a quality issue.
 75 |      */
 76 |     const DELIVERY_STATUS__QUALITY_ISSUE = 1;
 77 | 
 78 |     /**
 79 |      * The app delivered the wrong item.
 80 |      */
 81 |     const DELIVERY_STATUS__WRONG_ITEM = 2;
 82 | 
 83 |     /**
 84 |      * The app didn't deliver the consumable in-app purchase due to a server outage.
 85 |      */
 86 |     const DELIVERY_STATUS__SERVER_OUTAGE = 3;
 87 | 
 88 |     /**
 89 |      * The app didn't deliver the consumable in-app purchase due to an in-game currency change.
 90 |      */
 91 |     const DELIVERY_STATUS__CURRENCY_CHANGE = 4;
 92 | 
 93 |     /**
 94 |      * The app didn't deliver the consumable in-app purchase for other reasons.
 95 |      */
 96 |     const DELIVERY_STATUS__OTHER = 5;
 97 | 
 98 |     /**
 99 |      * Lifetime purchase amount is undeclared.
100 |      */
101 |     const LIFETIME_DOLLARS_PURCHASED__UNDECLARED = 0;
102 | 
103 |     /**
104 |      * Lifetime purchase amount is 0 USD.
105 |      */
106 |     const LIFETIME_DOLLARS_PURCHASED__0 = 1;
107 | 
108 |     /**
109 |      * Lifetime purchase amount is between 0.01–49.99 USD.
110 |      */
111 |     const LIFETIME_DOLLARS_PURCHASED__50 = 2;
112 | 
113 |     /**
114 |      * Lifetime purchase amount is between 50–99.99 USD.
115 |      */
116 |     const LIFETIME_DOLLARS_PURCHASED__100 = 3;
117 | 
118 |     /**
119 |      * Lifetime purchase amount is between 100–499.99 USD.
120 |      */
121 |     const LIFETIME_DOLLARS_PURCHASED__500 = 4;
122 | 
123 |     /**
124 |      * Lifetime purchase amount is between 500–999.99 USD.
125 |      */
126 |     const LIFETIME_DOLLARS_PURCHASED__1000 = 5;
127 | 
128 |     /**
129 |      * Lifetime purchase amount is between 1000–1999.99 USD.
130 |      */
131 |     const LIFETIME_DOLLARS_PURCHASED__2000 = 6;
132 | 
133 |     /**
134 |      * Lifetime purchase amount is over 2000 USD.
135 |      */
136 |     const LIFETIME_DOLLARS_PURCHASED__OVER_2000 = 7;
137 | 
138 |     /**
139 |      * Lifetime refund amount is undeclared.
140 |      */
141 |     const LIFETIME_DOLLARS_REFUNDED__UNDECLARED = 0;
142 | 
143 |     /**
144 |      * Lifetime refund amount is 0 USD.
145 |      */
146 |     const LIFETIME_DOLLARS_REFUNDED__0 = 1;
147 | 
148 |     /**
149 |      * Lifetime refund amount is between 0.01–49.99 USD.
150 |      */
151 |     const LIFETIME_DOLLARS_REFUNDED__50 = 2;
152 | 
153 |     /**
154 |      * Lifetime refund amount is between 50–99.99 USD.
155 |      */
156 |     const LIFETIME_DOLLARS_REFUNDED__100 = 3;
157 | 
158 |     /**
159 |      * Lifetime refund amount is between 100–499.99 USD.
160 |      */
161 |     const LIFETIME_DOLLARS_REFUNDED__500 = 4;
162 | 
163 |     /**
164 |      * Lifetime refund amount is between 500–999.99 USD.
165 |      */
166 |     const LIFETIME_DOLLARS_REFUNDED__1000 = 5;
167 | 
168 |     /**
169 |      * Lifetime refund amount is between 1000–1999.99 USD.
170 |      */
171 |     const LIFETIME_DOLLARS_REFUNDED__2000 = 6;
172 | 
173 |     /**
174 |      * Lifetime refund amount is over 2000 USD.
175 |      */
176 |     const LIFETIME_DOLLARS_REFUNDED__OVER_2000 = 7;
177 | 
178 |     /**
179 |      * Undeclared.
180 |      */
181 |     const PLATFORM__UNDECLARED = 0;
182 | 
183 |     /**
184 |      * An Apple platform.
185 |      */
186 |     const PLATFORM__APPLE = 1;
187 | 
188 |     /**
189 |      * Non-Apple platform.
190 |      */
191 |     const PLATFORM__NON_APPLE = 2;
192 | 
193 |     /**
194 |      * The engagement time is undeclared.
195 |      */
196 |     const PLAY_TIME__UNDECLARED = 0;
197 | 
198 |     /**
199 |      * The engagement time is between 0–5 minutes.
200 |      */
201 |     const PLAY_TIME__5_MINUTES = 1;
202 | 
203 |     /**
204 |      * The engagement time is between 5–60 minutes.
205 |      */
206 |     const PLAY_TIME__1_HOUR = 2;
207 | 
208 |     /**
209 |      * The engagement time is between 1–6 hours.
210 |      */
211 |     const PLAY_TIME__6_HOURS = 3;
212 | 
213 |     /**
214 |      * The engagement time is between 6–24 hours.
215 |      */
216 |     const PLAY_TIME__1_DAY = 4;
217 | 
218 |     /**
219 |      * The engagement time is between 1–4 days.
220 |      */
221 |     const PLAY_TIME__4_DAYS = 5;
222 | 
223 |     /**
224 |      * The engagement time is between 4–16 days.
225 |      */
226 |     const PLAY_TIME__16_DAYS = 6;
227 | 
228 |     /**
229 |      * The engagement time is over 16 days.
230 |      */
231 |     const PLAY_TIME__OVER_16_DAYS = 7;
232 | 
233 |     /**
234 |      * Account status is undeclared.
235 |      */
236 |     const USER_STATUS__UNDECLARED = 0;
237 | 
238 |     /**
239 |      * The customer’s account is active.
240 |      */
241 |     const USER_STATUS__ACTIVE = 1;
242 | 
243 |     /**
244 |      * The customer’s account is suspended.
245 |      */
246 |     const USER_STATUS__SUSPENDED = 2;
247 | 
248 |     /**
249 |      * The customer’s account is terminated.
250 |      */
251 |     const USER_STATUS__TERMINATED = 3;
252 | 
253 |     /**
254 |      * The customer’s account has limited access.
255 |      */
256 |     const USER_STATUS__LIMITED_ACCESS = 4;
257 | 
258 |     /**
259 |      * The age of the customer’s account.
260 |      */
261 |     protected int $accountTenure;
262 | 
263 |     /**
264 |      * The UUID of the in-app user account that completed the consumable in-app purchase transaction.
265 |      */
266 |     protected string $appAccountToken;
267 | 
268 |     /**
269 |      * A value that indicates the extent to which the customer consumed the in-app purchase.
270 |      */
271 |     protected int $consumptionStatus;
272 | 
273 |     /**
274 |      * A Boolean value of true or false that indicates whether the customer consented to provide consumption data.
275 |      */
276 |     protected bool $customerConsented;
277 | 
278 |     /**
279 |      * A value that indicates whether the app successfully delivered an in-app purchase that works properly.
280 |      */
281 |     protected int $deliveryStatus;
282 | 
283 |     /**
284 |      * A value that indicates the total amount, in USD, of in-app purchases the customer has made in your app, across all platforms.
285 |      */
286 |     protected int $lifetimeDollarsPurchased;
287 | 
288 |     /**
289 |      * A value that indicates the total amount, in USD, of refunds the customer has received, in your app, across all platforms.
290 |      */
291 |     protected int $lifetimeDollarsRefunded;
292 | 
293 |     /**
294 |      * A value that indicates the platform on which the customer consumed the in-app purchase.
295 |      */
296 |     protected int $platform;
297 | 
298 |     /**
299 |      * A value that indicates the amount of time that the customer used the app.
300 |      */
301 |     protected int $playTime;
302 | 
303 |     /**
304 |      * A Boolean value of true or false that indicates whether you provided, prior to its purchase, a free sample or trial of the content, or information about its functionality.
305 |      */
306 |     protected bool $sampleContentProvided;
307 | 
308 |     /**
309 |      * The status of the customer’s account.
310 |      */
311 |     protected int $userStatus;
312 | 
313 |     protected array $requiredFields = ['*'];
314 | }
315 | 


--------------------------------------------------------------------------------
/src/RenewalInfo.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | declare(strict_types=1);
  3 | 
  4 | namespace Readdle\AppStoreServerAPI;
  5 | 
  6 | use JsonSerializable;
  7 | use Readdle\AppStoreServerAPI\Util\Helper;
  8 | 
  9 | use function get_object_vars;
 10 | 
 11 | final class RenewalInfo implements JsonSerializable
 12 | {
 13 |     /**
 14 |      * Automatic renewal is off.
 15 |      * The customer has turned off automatic renewal for the subscription, and it won't renew at the end of the current
 16 |      * subscription period.
 17 |      */
 18 |     const AUTO_RENEW_STATUS__OFF = 0;
 19 | 
 20 |     /**
 21 |      * Automatic renewal is on.
 22 |      * The subscription renews at the end of the current subscription period.
 23 |      */
 24 |     const AUTO_RENEW_STATUS__ON = 1;
 25 | 
 26 |     /**
 27 |      * The customer canceled their subscription.
 28 |      */
 29 |     public const EXPIRATION_INTENT__CANCEL = 1;
 30 | 
 31 |     /**
 32 |      * Billing error; for example, the customer's payment information is no longer valid.
 33 |      */
 34 |     public const EXPIRATION_INTENT__BILLING_ERROR = 2;
 35 | 
 36 |     /**
 37 |      * The customer didn't consent to an auto-renewable subscription price increase
 38 |      * that requires customer consent, allowing the subscription to expire.
 39 |      */
 40 |     public const EXPIRATION_INTENT__PRICE_INCREASE = 3;
 41 | 
 42 |     /**
 43 |      * The product wasn't available for purchase at the time of renewal.
 44 |      */
 45 |     public const EXPIRATION_INTENT__UNAVAILABLE_PRODUCT = 4;
 46 | 
 47 |     /**
 48 |      * An introductory offer.
 49 |      */
 50 |     public const OFFER_TYPE__INTRODUCTORY = 1;
 51 | 
 52 |     /**
 53 |      * A promotional offer.
 54 |      */
 55 |     public const OFFER_TYPE__PROMOTIONAL = 2;
 56 | 
 57 |     /**
 58 |      * An offer with a subscription offer code.
 59 |      */
 60 |     public const OFFER_TYPE__SUBSCRIPTION_OFFER_CODE = 3;
 61 | 
 62 |     /**
 63 |      * The customer hasn't yet responded to an auto-renewable subscription price increase that requires customer
 64 |      * consent.
 65 |      */
 66 |     public const PRICE_INCREASE_STATUS__NOT_RESPONDED = 0;
 67 | 
 68 |     /**
 69 |      * The customer consented to an auto-renewable subscription price increase that requires customer consent,
 70 |      * or the App Store has notified the customer of an auto-renewable subscription price increase that doesn't require
 71 |      * consent.
 72 |      */
 73 |     public const PRICE_INCREASE_STATUS__CONSENTED = 1;
 74 | 
 75 |     /**
 76 |      * The product identifier of the product that renews at the next billing period.
 77 |      */
 78 |     private string $autoRenewProductId;
 79 | 
 80 |     /**
 81 |      * The renewal status for an auto-renewable subscription.
 82 |      */
 83 |     private int $autoRenewStatus;
 84 | 
 85 |     /**
 86 |      * The server environment, either sandbox or production.
 87 |      */
 88 |     private string $environment;
 89 | 
 90 |     /**
 91 |      * The reason a subscription expired.
 92 |      */
 93 |     private ?int $expirationIntent = null;
 94 | 
 95 |     /**
 96 |      * The time when the billing grace period for subscription renewals expires.
 97 |      */
 98 |     private ?int $gracePeriodExpiresDate = null;
 99 | 
100 |     /**
101 |      * The Boolean value that indicates whether the App Store is attempting to automatically renew an expired
102 |      * subscription.
103 |      */
104 |     private ?bool $isInBillingRetryPeriod = null;
105 | 
106 |     /**
107 |      * The offer code or the promotional offer identifier.
108 |      */
109 |     private ?string $offerIdentifier = null;
110 | 
111 |     /**
112 |      * The type of subscription offer.
113 |      */
114 |     private ?int $offerType = null;
115 | 
116 |     /**
117 |      * The original transaction identifier of a purchase.
118 |      */
119 |     private string $originalTransactionId;
120 | 
121 |     /**
122 |      * The status that indicates whether the auto-renewable subscription is subject to a price increase.
123 |      */
124 |     private ?int $priceIncreaseStatus = null;
125 | 
126 |     /**
127 |      * The product identifier of the in-app purchase.
128 |      */
129 |     private string $productId;
130 | 
131 |     /**
132 |      * The earliest start date of an auto-renewable subscription in a series of subscription purchases
133 |      * that ignores all lapses of paid service that are 60 days or less.
134 |      */
135 |     private int $recentSubscriptionStartDate;
136 | 
137 |     /**
138 |      * The UNIX time, in milliseconds, that the most recent auto-renewable subscription purchase expires.
139 |      *
140 |      * The renewalDate is a value that’s always present in the payload for auto-renewable subscriptions,
141 |      * even for expired subscriptions. This date indicates the expiration date of the most recent auto-renewable
142 |      * subscription purchase, including renewals, and may be in the past. For subscriptions that renew successfully,
143 |      * the renewalDate is the date when the subscription renews.
144 |      */
145 |     private ?int $renewalDate = null;
146 | 
147 |     /**
148 |      * The UNIX time, in milliseconds, that the App Store signed the JSON Web Signature data.
149 |      */
150 |     private int $signedDate;
151 | 
152 |     private function __construct()
153 |     {
154 |         // just a stub which prevents this class from direct instantiation
155 |     }
156 | 
157 |     /**
158 |      * @param array<string, mixed> $rawRenewalInfo
159 |      */
160 |     public static function createFromRawRenewalInfo(array $rawRenewalInfo): self
161 |     {
162 |         $renewalInfo = new self();
163 |         $typeCaster = Helper::arrayTypeCastGenerator($rawRenewalInfo, [
164 |             'int' => [
165 |                 'autoRenewStatus', 'expirationIntent', 'gracePeriodExpiresDate', 'offerType',
166 |                 'priceIncreaseStatus', 'recentSubscriptionStartDate', 'renewalDate', 'signedDate',
167 |             ],
168 |             'bool' => [
169 |                 'isInBillingRetryPeriod',
170 |             ],
171 |             'string' => [
172 |                 'autoRenewProductId', 'environment', 'offerIdentifier',
173 |                 'originalTransactionId', 'productId',
174 |             ],
175 |         ]);
176 | 
177 |         foreach ($typeCaster as $prop => $value) {
178 |             $renewalInfo->$prop = $value;
179 |         }
180 | 
181 |         return $renewalInfo;
182 |     }
183 | 
184 |     /**
185 |      * Returns the product identifier of the product that renews at the next billing period.
186 |      */
187 |     public function getAutoRenewProductId(): string
188 |     {
189 |         return $this->autoRenewProductId;
190 |     }
191 | 
192 |     /**
193 |      * Returns the renewal status for an auto-renewable subscription.
194 |      *
195 |      * @return self::AUTO_RENEW_STATUS__*
196 |      */
197 |     public function getAutoRenewStatus(): int
198 |     {
199 |         /** @phpstan-ignore-next-line */
200 |         return $this->autoRenewStatus;
201 |     }
202 | 
203 |     /**
204 |      * Returns the server environment, either sandbox or production.
205 |      *
206 |      * @return Environment::PRODUCTION|Environment::SANDBOX
207 |      */
208 |     public function getEnvironment(): string
209 |     {
210 |         return $this->environment;
211 |     }
212 | 
213 |     /**
214 |      * Returns the reason a subscription expired (if any).
215 |      *
216 |      * @return null|self::EXPIRATION_INTENT__*
217 |      */
218 |     public function getExpirationIntent(): ?int
219 |     {
220 |         /** @phpstan-ignore-next-line */
221 |         return $this->expirationIntent;
222 |     }
223 | 
224 |     /**
225 |      * Returns the time when the billing grace period for subscription renewals expires (if any).
226 |      */
227 |     public function getGracePeriodExpiresDate(): ?int
228 |     {
229 |         return $this->gracePeriodExpiresDate;
230 |     }
231 | 
232 |     /**
233 |      * Returns the Boolean value that indicates whether the App Store is attempting to automatically renew an expired
234 |      * subscription.
235 |      */
236 |     public function getIsInBillingRetryPeriod(): ?bool
237 |     {
238 |         return $this->isInBillingRetryPeriod;
239 |     }
240 | 
241 |     /**
242 |      * Returns the offer code or the promotional offer identifier (if any).
243 |      */
244 |     public function getOfferIdentifier(): ?string
245 |     {
246 |         return $this->offerIdentifier;
247 |     }
248 | 
249 |     /**
250 |      * Returns the type of subscription offer (if any).
251 |      *
252 |      * @return self::OFFER_TYPE__*
253 |      */
254 |     public function getOfferType(): ?int
255 |     {
256 |         /** @phpstan-ignore-next-line */
257 |         return $this->offerType;
258 |     }
259 | 
260 |     /**
261 |      * Returns the original transaction identifier of a purchase.
262 |      */
263 |     public function getOriginalTransactionId(): string
264 |     {
265 |         return $this->originalTransactionId;
266 |     }
267 | 
268 |     /**
269 |      * Returns the status that indicates whether the auto-renewable subscription is subject to a price increase (if any)
270 |      *
271 |      * @return self::PRICE_INCREASE_STATUS__*
272 |      */
273 |     public function getPriceIncreaseStatus(): ?int
274 |     {
275 |         /** @phpstan-ignore-next-line */
276 |         return $this->priceIncreaseStatus;
277 |     }
278 | 
279 |     /**
280 |      * Returns the product identifier of the in-app purchase.
281 |      */
282 |     public function getProductId(): string
283 |     {
284 |         return $this->productId;
285 |     }
286 | 
287 |     /**
288 |      * Returns the earliest start date of an auto-renewable subscription in a series of subscription purchases
289 |      * that ignores all lapses of paid service that are 60 days or less.
290 |      */
291 |     public function getRecentSubscriptionStartDate(): int
292 |     {
293 |         return $this->recentSubscriptionStartDate;
294 |     }
295 | 
296 |     /**
297 |      * Returns the UNIX time, in milliseconds, that the most recent auto-renewable subscription purchase expires.
298 |      */
299 |     public function getRenewalDate(): ?int
300 |     {
301 |         return $this->renewalDate;
302 |     }
303 | 
304 |     /**
305 |      * Returns the UNIX time, in milliseconds, that the App Store signed the JSON Web Signature data.
306 |      */
307 |     public function getSignedDate(): int
308 |     {
309 |         return $this->signedDate;
310 |     }
311 | 
312 |     /**
313 |      * @return array<string, mixed>
314 |      */
315 |     public function jsonSerialize(): array
316 |     {
317 |         return get_object_vars($this);
318 |     }
319 | }
320 | 


--------------------------------------------------------------------------------
/src/AppStoreServerAPI.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | declare(strict_types=1);
  3 | 
  4 | namespace Readdle\AppStoreServerAPI;
  5 | 
  6 | use Exception;
  7 | use Readdle\AppStoreServerAPI\Exception\HTTPRequestAborted;
  8 | use Readdle\AppStoreServerAPI\Exception\HTTPRequestFailed;
  9 | use Readdle\AppStoreServerAPI\Exception\WrongEnvironmentException;
 10 | use Readdle\AppStoreServerAPI\Exception\InvalidImplementationException;
 11 | use Readdle\AppStoreServerAPI\Exception\MalformedResponseException;
 12 | use Readdle\AppStoreServerAPI\Exception\UnimplementedContentTypeException;
 13 | use Readdle\AppStoreServerAPI\Request\AbstractRequest;
 14 | use Readdle\AppStoreServerAPI\Request\ExtendSubscriptionRenewalDateRequest;
 15 | use Readdle\AppStoreServerAPI\Request\GetAllSubscriptionStatusesRequest;
 16 | use Readdle\AppStoreServerAPI\Request\GetNotificationHistoryRequest;
 17 | use Readdle\AppStoreServerAPI\Request\GetRefundHistoryRequest;
 18 | use Readdle\AppStoreServerAPI\Request\GetStatusOfSubscriptionRenewalDateExtensionsRequest;
 19 | use Readdle\AppStoreServerAPI\Request\GetTestNotificationStatusRequest;
 20 | use Readdle\AppStoreServerAPI\Request\GetTransactionHistoryRequest;
 21 | use Readdle\AppStoreServerAPI\Request\GetTransactionInfoRequest;
 22 | use Readdle\AppStoreServerAPI\Request\LookUpOrderIdRequest;
 23 | use Readdle\AppStoreServerAPI\Request\MassExtendSubscriptionRenewalDateRequest;
 24 | use Readdle\AppStoreServerAPI\Request\RequestTestNotificationRequest;
 25 | use Readdle\AppStoreServerAPI\Request\SendConsumptionInformationRequest;
 26 | use Readdle\AppStoreServerAPI\RequestBody\AbstractRequestBody;
 27 | use Readdle\AppStoreServerAPI\RequestBody\ConsumptionRequestBody;
 28 | use Readdle\AppStoreServerAPI\RequestBody\ExtendRenewalDateRequestBody;
 29 | use Readdle\AppStoreServerAPI\RequestBody\MassExtendRenewalDateRequestBody;
 30 | use Readdle\AppStoreServerAPI\RequestBody\NotificationHistoryRequestBody;
 31 | use Readdle\AppStoreServerAPI\RequestQueryParams\AbstractRequestQueryParams;
 32 | use Readdle\AppStoreServerAPI\RequestQueryParams\GetAllSubscriptionStatusesQueryParams;
 33 | use Readdle\AppStoreServerAPI\RequestQueryParams\GetNotificationHistoryQueryParams;
 34 | use Readdle\AppStoreServerAPI\RequestQueryParams\GetRefundHistoryQueryParams;
 35 | use Readdle\AppStoreServerAPI\RequestQueryParams\GetTransactionHistoryQueryParams;
 36 | use Readdle\AppStoreServerAPI\Response\AbstractResponse;
 37 | use Readdle\AppStoreServerAPI\Response\CheckTestNotificationResponse;
 38 | use Readdle\AppStoreServerAPI\Response\ExtendRenewalDateResponse;
 39 | use Readdle\AppStoreServerAPI\Response\MassExtendRenewalDateResponse;
 40 | use Readdle\AppStoreServerAPI\Response\MassExtendRenewalDateStatusResponse;
 41 | use Readdle\AppStoreServerAPI\Response\NotificationHistoryResponse;
 42 | use Readdle\AppStoreServerAPI\Response\OrderLookupResponse;
 43 | use Readdle\AppStoreServerAPI\Response\RefundHistoryResponse;
 44 | use Readdle\AppStoreServerAPI\Response\SendTestNotificationResponse;
 45 | use Readdle\AppStoreServerAPI\Response\HistoryResponse;
 46 | use Readdle\AppStoreServerAPI\Response\StatusResponse;
 47 | use Readdle\AppStoreServerAPI\Response\TransactionInfoResponse;
 48 | 
 49 | use function call_user_func;
 50 | use function in_array;
 51 | use function is_subclass_of;
 52 | 
 53 | final class AppStoreServerAPI implements AppStoreServerAPIInterface
 54 | {
 55 |     const PRODUCTION_BASE_URL = 'https://api.storekit.itunes.apple.com/inApps';
 56 |     const SANDBOX_BASE_URL = 'https://api.storekit-sandbox.itunes.apple.com/inApps';
 57 | 
 58 |     private string $environment;
 59 |     private Payload $payload;
 60 |     private Key $key;
 61 | 
 62 |     /**
 63 |      * @throws WrongEnvironmentException
 64 |      */
 65 |     public function __construct(string $environment, string $issuerId, string $bundleId, string $keyId, string $key)
 66 |     {
 67 |         if (!in_array($environment, [Environment::PRODUCTION, Environment::SANDBOX])) {
 68 |             throw new WrongEnvironmentException($environment);
 69 |         }
 70 | 
 71 |         $this->environment = $environment;
 72 |         $this->payload = new Payload($issuerId, $bundleId);
 73 |         $this->key = new Key($keyId, $key);
 74 |     }
 75 | 
 76 |     public function getTransactionHistory(string $transactionId, array $queryParams = []): HistoryResponse
 77 |     {
 78 |         /**
 79 |          * @var HistoryResponse $response
 80 |          */
 81 |         $response = $this->performRequest(
 82 |             GetTransactionHistoryRequest::class,
 83 |             HistoryResponse::class,
 84 |             ['transactionId' => $transactionId],
 85 |             new GetTransactionHistoryQueryParams($queryParams)
 86 |         );
 87 |         return $response;
 88 |     }
 89 | 
 90 |     public function getTransactionInfo(string $transactionId): TransactionInfoResponse
 91 |     {
 92 |         /**
 93 |          * @var TransactionInfoResponse $response
 94 |          */
 95 |         $response = $this->performRequest(
 96 |             GetTransactionInfoRequest::class,
 97 |             TransactionInfoResponse::class,
 98 |             ['transactionId' => $transactionId],
 99 |         );
100 |         return $response;
101 |     }
102 | 
103 |     public function getAllSubscriptionStatuses(string $transactionId, array $queryParams = []): StatusResponse
104 |     {
105 |         /**
106 |          * @var StatusResponse $response
107 |          */
108 |         $response = $this->performRequest(
109 |             GetAllSubscriptionStatusesRequest::class,
110 |             StatusResponse::class,
111 |             ['transactionId' => $transactionId],
112 |             new GetAllSubscriptionStatusesQueryParams($queryParams)
113 |         );
114 |         return $response;
115 |     }
116 | 
117 |     public function sendConsumptionInformation(string $transactionId, array $requestBody): void
118 |     {
119 |         $this->performRequest(
120 |             SendConsumptionInformationRequest::class,
121 |             null,
122 |             ['transactionId' => $transactionId],
123 |             null,
124 |             new ConsumptionRequestBody($requestBody)
125 |         );
126 |     }
127 | 
128 |     public function lookUpOrderId(string $orderId): OrderLookupResponse
129 |     {
130 |         /**
131 |          * @var OrderLookupResponse $response
132 |          */
133 |         $response = $this->performRequest(
134 |             LookUpOrderIdRequest::class,
135 |             OrderLookupResponse::class,
136 |             ['orderId' => $orderId],
137 |         );
138 |         return $response;
139 |     }
140 | 
141 |     public function getRefundHistory(string $transactionId): RefundHistoryResponse
142 |     {
143 |         /**
144 |          * @var RefundHistoryResponse $response
145 |          */
146 |         $response = $this->performRequest(
147 |             GetRefundHistoryRequest::class,
148 |             RefundHistoryResponse::class,
149 |             ['transactionId' => $transactionId],
150 |             new GetRefundHistoryQueryParams()
151 |         );
152 |         return $response;
153 |     }
154 | 
155 |     /**
156 |      * @inheritdoc
157 |      * @throws Exception
158 |      */
159 |     public function extendSubscriptionRenewalDate(
160 |         string $originalTransactionId,
161 |         array $requestBody
162 |     ): ExtendRenewalDateResponse {
163 |         /**
164 |          * @var ExtendRenewalDateResponse $response
165 |          */
166 |         $response = $this->performRequest(
167 |             ExtendSubscriptionRenewalDateRequest::class,
168 |             ExtendRenewalDateResponse::class,
169 |             ['originalTransactionId' => $originalTransactionId],
170 |             null,
171 |             new ExtendRenewalDateRequestBody($requestBody)
172 |         );
173 |         return $response;
174 | 
175 |     }
176 | 
177 |     /**
178 |      * @inheritdoc
179 |      * @throws Exception
180 |      */
181 |     public function massExtendSubscriptionRenewalDate(array $requestBody): MassExtendRenewalDateResponse
182 |     {
183 |         /**
184 |          * @var MassExtendRenewalDateResponse $response
185 |          */
186 |         $response = $this->performRequest(
187 |             MassExtendSubscriptionRenewalDateRequest::class,
188 |             MassExtendRenewalDateResponse::class,
189 |             [],
190 |             null,
191 |             new MassExtendRenewalDateRequestBody($requestBody)
192 |         );
193 |         return $response;
194 | 
195 |     }
196 | 
197 |     public function getStatusOfSubscriptionRenewalDateExtensionsRequest(
198 |         string $productId,
199 |         string $requestIdentifier
200 |     ): MassExtendRenewalDateStatusResponse {
201 |         /**
202 |          * @var MassExtendRenewalDateStatusResponse $response
203 |          */
204 |         $response = $this->performRequest(
205 |             GetStatusOfSubscriptionRenewalDateExtensionsRequest::class,
206 |             MassExtendRenewalDateStatusResponse::class,
207 |             [
208 |                 'productId' => $productId,
209 |                 'requestIdentifier' => $requestIdentifier,
210 |             ]
211 |         );
212 |         return $response;
213 |     }
214 | 
215 | 
216 |     public function getNotificationHistory(array $requestBody): NotificationHistoryResponse
217 |     {
218 |         /**
219 |          * @var NotificationHistoryResponse $response
220 |          */
221 |         $response = $this->performRequest(
222 |             GetNotificationHistoryRequest::class,
223 |             NotificationHistoryResponse::class,
224 |             [],
225 |             new GetNotificationHistoryQueryParams(),
226 |             new NotificationHistoryRequestBody($requestBody)
227 |         );
228 |         return $response;
229 |     }
230 | 
231 |     public function requestTestNotification(): SendTestNotificationResponse
232 |     {
233 |         /**
234 |          * @var SendTestNotificationResponse $response
235 |          */
236 |         $response = $this->performRequest(RequestTestNotificationRequest::class, SendTestNotificationResponse::class);
237 |         return $response;
238 |     }
239 | 
240 |     public function getTestNotificationStatus(string $testNotificationToken): CheckTestNotificationResponse
241 |     {
242 |         /**
243 |          * @var CheckTestNotificationResponse $response
244 |          */
245 |         $response = $this->performRequest(
246 |             GetTestNotificationStatusRequest::class,
247 |             CheckTestNotificationResponse::class,
248 |             ['testNotificationToken' => $testNotificationToken],
249 |         );
250 |         return $response;
251 | 
252 |     }
253 | 
254 |     private function createRequest(
255 |         string $requestClass,
256 |         ?AbstractRequestQueryParams $queryParams,
257 |         ?AbstractRequestBody $body
258 |     ): AbstractRequest {
259 |         /** @var AbstractRequest $request */
260 |         $request = new $requestClass($this->key, $this->payload, $queryParams, $body);
261 |         $request->setURLVars(['baseUrl' => $this->getBaseURL()]);
262 |         return $request;
263 |     }
264 | 
265 |     private function getBaseURL(): string
266 |     {
267 |         return $this->environment === Environment::PRODUCTION ? self::PRODUCTION_BASE_URL : self::SANDBOX_BASE_URL;
268 |     }
269 | 
270 |     /**
271 |      * @param array<string, mixed> $requestUrlVars
272 |      *
273 |      * @throws HTTPRequestAborted
274 |      * @throws HTTPRequestFailed
275 |      * @throws InvalidImplementationException
276 |      * @throws MalformedResponseException
277 |      * @throws UnimplementedContentTypeException
278 |      */
279 |     private function performRequest(
280 |         string $requestClass,
281 |         ?string $responseClass,
282 |         array $requestUrlVars = [],
283 |         ?AbstractRequestQueryParams $requestQueryParams = null,
284 |         ?AbstractRequestBody $requestBody = null
285 |     ): ?AbstractResponse {
286 |         if (
287 |             !is_subclass_of($requestClass, AbstractRequest::class)
288 |             || (!empty($responseClass) && !is_subclass_of($responseClass, AbstractResponse::class))
289 |         ) {
290 |             throw new InvalidImplementationException($requestClass, $responseClass);
291 |         }
292 | 
293 |         $request = $this->createRequest($requestClass, $requestQueryParams, $requestBody);
294 | 
295 |         if (!empty($requestUrlVars)) {
296 |             $request->setURLVars($requestUrlVars);
297 |         }
298 | 
299 |         $responseText = HTTPRequest::performRequest($request);
300 | 
301 |         if (empty($responseClass)) {
302 |             return null;
303 |         }
304 | 
305 |         return call_user_func([$responseClass, 'createFromString'], $responseText, $request);
306 |     }
307 | }
308 | 


--------------------------------------------------------------------------------
/src/TransactionInfo.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | declare(strict_types=1);
  3 | 
  4 | namespace Readdle\AppStoreServerAPI;
  5 | 
  6 | use JsonSerializable;
  7 | use Readdle\AppStoreServerAPI\Util\Helper;
  8 | 
  9 | use function get_object_vars;
 10 | 
 11 | final class TransactionInfo implements JsonSerializable
 12 | {
 13 |     /**
 14 |      * The transaction belongs to a family member who benefits from the service.
 15 |      */
 16 |     public const IN_APP_OWNERSHIP_TYPE__FAMILY_SHARED = 'FAMILY_SHARED';
 17 | 
 18 |     /**
 19 |      * The transaction belongs to the purchaser.
 20 |      */
 21 |     public const IN_APP_OWNERSHIP_TYPE__PURCHASED = 'PURCHASED';
 22 | 
 23 |     /**
 24 |      * A payment mode of a product discount that indicates a free trial.
 25 |      */
 26 |     public const OFFER_DISCOUNT_TYPE__FREE_TRIAL = 'FREE_TRIAL';
 27 | 
 28 |     /**
 29 |      * A payment mode of a product discount that is billed over a single or multiple billing periods.
 30 |      */
 31 |     public const OFFER_DISCOUNT_TYPE__PAY_AS_YOU_GO = 'PAY_AS_YOU_GO';
 32 | 
 33 |     /**
 34 |      * A payment mode of a product discount that is paid up front.
 35 |      */
 36 |     public const OFFER_DISCOUNT_TYPE__PAY_UP_FRONT = 'PAY_UP_FRONT';
 37 | 
 38 |     /**
 39 |      * An introductory offer.
 40 |      */
 41 |     public const OFFER_TYPE__INTRODUCTORY = 1;
 42 | 
 43 |     /**
 44 |      * A promotional offer.
 45 |      */
 46 |     public const OFFER_TYPE__PROMOTIONAL = 2;
 47 | 
 48 |     /**
 49 |      * An offer with a subscription offer code.
 50 |      */
 51 |     public const OFFER_TYPE__SUBSCRIPTION = 3;
 52 | 
 53 |     /**
 54 |      * Apple Support refunded the transaction on behalf of the customer for other reasons; for example, an accidental
 55 |      * purchase.
 56 |      */
 57 |     public const REVOCATION_REASON__OTHER = 0;
 58 | 
 59 |     /**
 60 |      * Apple Support refunded the transaction on behalf of the customer due to an actual or perceived issue within your
 61 |      * app.
 62 |      */
 63 |     public const REVOCATION_REASON__ISSUE_WITHIN_APP = 1;
 64 | 
 65 |     /**
 66 |      * The customer initiated the purchase, which may be for any in-app purchase type: consumable, non-consumable,
 67 |      * non-renewing subscription, or auto-renewable subscription.
 68 |      */
 69 |     public const TRANSACTION_REASON__PURCHASE = 'PURCHASE';
 70 | 
 71 |     /**
 72 |      * The App Store server initiated the purchase transaction to renew an auto-renewable subscription.
 73 |      */
 74 |     public const TRANSACTION_REASON__RENEWAL = 'RENEWAL';
 75 | 
 76 |     /**
 77 |      * An auto-renewable subscription.
 78 |      */
 79 |     public const TYPE__AUTO_RENEWABLE_SUBSCRIPTION = 'Auto-Renewable Subscription';
 80 | 
 81 |     /**
 82 |      * A non-consumable in-app purchase.
 83 |      */
 84 |     public const TYPE__NON_CONSUMABLE = 'Non-Consumable';
 85 | 
 86 |     /**
 87 |      * A consumable in-app purchase.
 88 |      */
 89 |     public const TYPE__CONSUMABLE = 'Consumable';
 90 | 
 91 |     /**
 92 |      * A non-renewing subscription.
 93 |      */
 94 |     public const TYPE__NON_RENEWING_SUBSCRIPTION = 'Non-Renewing Subscription';
 95 | 
 96 |     /**
 97 |      * A UUID that associates the transaction with a user on your own service.
 98 |      * If the app doesn't provide an appAccountToken, this string is empty.
 99 |      */
100 |     private ?string $appAccountToken = null;
101 | 
102 |     /**
103 |      * The bundle identifier of the app.
104 |      */
105 |     private string $bundleId;
106 | 
107 |     /**
108 |      * The three-letter ISO 4217 currency code associated with the price parameter. This value is present only if price is
109 |      * present.
110 |      */
111 |     private ?string $currency = null;
112 | 
113 |     /**
114 |      * The server environment, either sandbox or production.
115 |      */
116 |     private string $environment;
117 | 
118 |     /**
119 |      * The UNIX time, in milliseconds, the subscription expires or renews.
120 |      */
121 |     private ?int $expiresDate = null;
122 | 
123 |     /**
124 |      * A string that describes whether the transaction was purchased by the user, or is available to them through Family
125 |      * Sharing.
126 |      */
127 |     private string $inAppOwnershipType;
128 | 
129 |     /**
130 |      * A Boolean value that indicates whether the user upgraded to another subscription.
131 |      */
132 |     private ?bool $isUpgraded = null;
133 | 
134 |     /**
135 |      * The payment mode you configure for the subscription offer, such as Free Trial, Pay As You Go, or Pay Up Front.
136 |      */
137 |     private ?string $offerDiscountType = null;
138 | 
139 |     /**
140 |      * The identifier that contains the promo code or the promotional offer identifier.
141 |      * NOTE: This field applies only when the offerType is either promotional offer or subscription offer code.
142 |      */
143 |     private ?string $offerIdentifier = null;
144 | 
145 |     /**
146 |      * A value that represents the promotional offer type.
147 |      */
148 |     private ?int $offerType = null;
149 | 
150 |     /**
151 |      * The UNIX time, in milliseconds, that represents the purchase date of the original transaction identifier.
152 |      */
153 |     private int $originalPurchaseDate;
154 | 
155 |     /**
156 |      * The transaction identifier of the original purchase.
157 |      */
158 |     private string $originalTransactionId;
159 | 
160 |     /**
161 |      * An integer value that represents the price multiplied by 1000 of the in-app purchase or subscription offer you
162 |      * configured in App Store Connect and that the system records at the time of the purchase. The currency parameter
163 |      * indicates the currency of this price.
164 |      */
165 |     private ?int $price = null;
166 | 
167 |     /**
168 |      * The product identifier of the in-app purchase.
169 |      */
170 |     private string $productId;
171 | 
172 |     /**
173 |      * The UNIX time, in milliseconds, that the App Store charged the user's account for a purchase,
174 |      * restored product, subscription, or subscription renewal after a lapse.
175 |      */
176 |     private int $purchaseDate;
177 | 
178 |     /**
179 |      * The number of consumable products the user purchased.
180 |      */
181 |     private int $quantity;
182 | 
183 |     /**
184 |      * The UNIX time, in milliseconds, that the App Store refunded the transaction or revoked it from Family Sharing.
185 |      */
186 |     private ?int $revocationDate = null;
187 | 
188 |     /**
189 |      * The reason that the App Store refunded the transaction or revoked it from Family Sharing.
190 |      */
191 |     private ?int $revocationReason = null;
192 | 
193 |     /**
194 |      * The UNIX time, in milliseconds, that the App Store signed the JSON Web Signature (JWS) data.
195 |      */
196 |     private int $signedDate;
197 | 
198 |     /**
199 |      * The three-letter code that represents the country or region associated with the App Store storefront for
200 |      * the purchase.
201 |      *
202 |      * This property uses the ISO 3166-1 alpha-3 country code representation.
203 |      * This property is the same as the countryCode in StoreKit.
204 |      */
205 |     private ?string $storefront = null;
206 | 
207 |     /**
208 |      * An Apple-defined value that uniquely identifies the App Store storefront associated with the purchase.
209 |      *
210 |      * This value is the same as the id value in StoreKit.
211 |      */
212 |     private ?string $storefrontId = null;
213 | 
214 |     /**
215 |      * The identifier of the subscription group the subscription belongs to.
216 |      */
217 |     private ?string $subscriptionGroupIdentifier = null;
218 | 
219 |     /**
220 |      * The unique identifier of the transaction.
221 |      */
222 |     private string $transactionId;
223 | 
224 |     /**
225 |      * The reason for the purchase transaction, which indicates whether it’s a customer’s purchase or a renewal for
226 |      * an auto-renewable subscription that the system initiates.
227 |      */
228 |     private ?string $transactionReason = null;
229 | 
230 |     /**
231 |      * The type of the in-app purchase.
232 |      */
233 |     private string $type;
234 | 
235 |     /**
236 |      * The unique identifier of subscription purchase events across devices, including subscription renewals.
237 |      */
238 |     private ?string $webOrderLineItemId = null;
239 | 
240 |     private function __construct()
241 |     {
242 |         // just a stub which prevents this class from direct instantiation
243 |     }
244 | 
245 |     /**
246 |      * @param array<string, mixed> $rawTransactionInfo
247 |      */
248 |     public static function createFromRawTransactionInfo(array $rawTransactionInfo): self
249 |     {
250 |         $transactionInfo = new self();
251 |         $typeCaster = Helper::arrayTypeCastGenerator($rawTransactionInfo, [
252 |             'int' => [
253 |                 'expiresDate', 'offerType', 'originalPurchaseDate', 'price', 'purchaseDate',
254 |                 'quantity', 'revocationDate', 'revocationReason', 'signedDate',
255 |             ],
256 |             'bool' => [
257 |                 'isUpgraded',
258 |             ],
259 |             'string' => [
260 |                 'appAccountToken', 'bundleId', 'currency', 'environment', 'inAppOwnershipType',
261 |                 'offerDiscountType', 'offerIdentifier', 'originalTransactionId', 'productId', 'storefront',
262 |                 'storefrontId', 'subscriptionGroupIdentifier', 'transactionId', 'transactionReason',
263 |                 'type', 'webOrderLineItemId',
264 |             ],
265 |         ]);
266 | 
267 |         foreach ($typeCaster as $prop => $value) {
268 |             $transactionInfo->$prop = $value;
269 |         }
270 | 
271 |         return $transactionInfo;
272 |     }
273 | 
274 |     /**
275 |      * Returns a UUID that associates the transaction with a user on your own service.
276 |      * If the app doesn't provide an appAccountToken, this string is empty.
277 |      */
278 |     public function getAppAccountToken(): ?string
279 |     {
280 |         return $this->appAccountToken;
281 |     }
282 | 
283 |     /**
284 |      * Returns the bundle identifier of the app.
285 |      */
286 |     public function getBundleId(): string
287 |     {
288 |         return $this->bundleId;
289 |     }
290 | 
291 |     /**
292 |      * Returns the three-letter ISO 4217 currency code for the price of the product.
293 |      */
294 |     public function getCurrency(): ?string
295 |     {
296 |         return $this->currency;
297 |     }
298 | 
299 |     /**
300 |      * Returns the server environment, either sandbox or production.
301 |      *
302 |      * @return Environment::PRODUCTION|Environment::SANDBOX
303 |      */
304 |     public function getEnvironment(): string
305 |     {
306 |         return $this->environment;
307 |     }
308 | 
309 |     /**
310 |      * Returns the UNIX time, in milliseconds, the subscription expires or renews (if any).
311 |      */
312 |     public function getExpiresDate(): ?int
313 |     {
314 |         return $this->expiresDate;
315 |     }
316 | 
317 |     /**
318 |      * Returns a string that describes whether the transaction was purchased by the user, or is available to them
319 |      * through Family Sharing.
320 |      *
321 |      * @return self::IN_APP_OWNERSHIP_TYPE__*
322 |      */
323 |     public function getInAppOwnershipType(): string
324 |     {
325 |         return $this->inAppOwnershipType;
326 |     }
327 | 
328 |     /**
329 |      * Returns a Boolean value that indicates whether the user upgraded to another subscription.
330 |      */
331 |     public function getIsUpgraded(): ?bool
332 |     {
333 |         return $this->isUpgraded;
334 |     }
335 | 
336 |     /**
337 |      * Returns the identifier that contains the promo code or the promotional offer identifier.
338 |      *
339 |      * NOTE: This field applies only when the offerType is either promotional offer or subscription offer code.
340 |      */
341 |     public function getOfferIdentifier(): ?string
342 |     {
343 |         return $this->offerIdentifier;
344 |     }
345 | 
346 |     /**
347 |      * Returns a value that represents the offer discount type (if any).
348 |      *
349 |      * @return null|self::OFFER_DISCOUNT_TYPE__*
350 |      */
351 |     public function getOfferDiscountType(): ?string
352 |     {
353 |         /** @phpstan-ignore-next-line */
354 |         return $this->offerDiscountType;
355 |     }
356 | 
357 |     /**
358 |      * Returns a value that represents the promotional offer type (if any).
359 |      *
360 |      * @return null|self::OFFER_TYPE__*
361 |      */
362 |     public function getOfferType(): ?int
363 |     {
364 |         /** @phpstan-ignore-next-line */
365 |         return $this->offerType;
366 |     }
367 | 
368 |     /**
369 |      * Returns the UNIX time, in milliseconds, that represents the purchase date of the original transaction identifier.
370 |      */
371 |     public function getOriginalPurchaseDate(): int
372 |     {
373 |         return $this->originalPurchaseDate;
374 |     }
375 | 
376 |     /**
377 |      * Returns the transaction identifier of the original purchase.
378 |      */
379 |     public function getOriginalTransactionId(): string
380 |     {
381 |         return $this->originalTransactionId;
382 |     }
383 | 
384 |     /**
385 |      * Returns the price multiplied by 1000 of the in-app purchase or subscription offer that you configured in App Store
386 |      * Connect, as an integer.
387 |      */
388 |     public function getPrice(): ?int
389 |     {
390 |         return $this->price;
391 |     }
392 | 
393 |     /**
394 |      * Returns the product identifier of the in-app purchase.
395 |      */
396 |     public function getProductId(): string
397 |     {
398 |         return $this->productId;
399 |     }
400 | 
401 |     /**
402 |      * Returns the UNIX time, in milliseconds, that the App Store charged the user's account for a purchase,
403 |      * restored product, subscription, or subscription renewal after a lapse.
404 |      */
405 |     public function getPurchaseDate(): int
406 |     {
407 |         return $this->purchaseDate;
408 |     }
409 | 
410 |     /**
411 |      * Returns the number of consumable products the user purchased.
412 |      */
413 |     public function getQuantity(): int
414 |     {
415 |         return $this->quantity;
416 |     }
417 | 
418 |     /**
419 |      * Returns the UNIX time, in milliseconds, that the App Store refunded the transaction or revoked it from
420 |      * Family Sharing (if any).
421 |      */
422 |     public function getRevocationDate(): ?int
423 |     {
424 |         return $this->revocationDate;
425 |     }
426 | 
427 |     /**
428 |      * The reason that the App Store refunded the transaction or revoked it from Family Sharing (if any).
429 |      *
430 |      * @return null|self::REVOCATION_REASON__*
431 |      */
432 |     public function getRevocationReason(): ?int
433 |     {
434 |         /** @phpstan-ignore-next-line */
435 |         return $this->revocationReason;
436 |     }
437 | 
438 |     /**
439 |      * Returns the UNIX time, in milliseconds, that the App Store signed the JSON Web Signature (JWS) data.
440 |      */
441 |     public function getSignedDate(): int
442 |     {
443 |         return $this->signedDate;
444 |     }
445 | 
446 |     /**
447 |      * Returns the three-letter code that represents the country or region associated with the App Store storefront for
448 |      * the purchase.
449 |      */
450 |     public function getStorefront(): ?string
451 |     {
452 |         return $this->storefront;
453 |     }
454 | 
455 |     /**
456 |      * Returns an Apple-defined value that uniquely identifies the App Store storefront associated with the purchase.
457 |      */
458 |     public function getStorefrontId(): ?string
459 |     {
460 |         return $this->storefrontId;
461 |     }
462 | 
463 |     /**
464 |      * Returns the identifier of the subscription group the subscription belongs to (if any).
465 |      */
466 |     public function getSubscriptionGroupIdentifier(): ?string
467 |     {
468 |         return $this->subscriptionGroupIdentifier;
469 |     }
470 | 
471 |     /**
472 |      * Returns the unique identifier of the transaction.
473 |      */
474 |     public function getTransactionId(): string
475 |     {
476 |         return $this->transactionId;
477 |     }
478 | 
479 |     /**
480 |      * Returns the type of the in-app purchase.
481 |      *
482 |      * @return self::TRANSACTION_REASON__*
483 |      */
484 |     public function getTransactionReason(): ?string
485 |     {
486 |         return $this->transactionReason;
487 |     }
488 | 
489 |     /**
490 |      * Returns the type of the in-app purchase.
491 |      *
492 |      * @return self::TYPE__*
493 |      */
494 |     public function getType(): string
495 |     {
496 |         return $this->type;
497 |     }
498 | 
499 |     /**
500 |      * Returns the unique identifier of subscription purchase events across devices, including subscription
501 |      * renewals (if any).
502 |      */
503 |     public function getWebOrderLineItemId(): ?string
504 |     {
505 |         return $this->webOrderLineItemId;
506 |     }
507 | 
508 |     /**
509 |      * @return array<string, mixed>
510 |      */
511 |     public function jsonSerialize(): array
512 |     {
513 |         return get_object_vars($this);
514 |     }
515 | }
516 | 


--------------------------------------------------------------------------------
/src/ResponseBodyV2.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | declare(strict_types=1);
  3 | 
  4 | namespace Readdle\AppStoreServerAPI;
  5 | 
  6 | use JsonSerializable;
  7 | use Readdle\AppStoreServerAPI\Exception\AppStoreServerNotificationException;
  8 | use Readdle\AppStoreServerAPI\Exception\MalformedJWTException;
  9 | use Readdle\AppStoreServerAPI\Util\JWT;
 10 | use Readdle\AppStoreServerAPI\Util\Helper;
 11 | 
 12 | use function array_key_exists;
 13 | use function json_decode;
 14 | use function json_last_error;
 15 | 
 16 | final class ResponseBodyV2 implements JsonSerializable
 17 | {
 18 |     /**
 19 |      * A notification type that indicates that the customer initiated a refund request for a consumable in-app purchase,
 20 |      * and the App Store is requesting that you provide consumption data.
 21 |      */
 22 |     const NOTIFICATION_TYPE__CONSUMPTION_REQUEST = 'CONSUMPTION_REQUEST';
 23 | 
 24 |     /**
 25 |      * A notification type that, along with its subtype, indicates that the user made a change to their subscription
 26 |      *  plan. If the subtype is UPGRADE, the user upgraded their subscription, or cross-graded to a subscription with
 27 |      *  the same duration. The upgrade goes into effect immediately, starting a new billing period, and the user receives
 28 |      *  a prorated refund for the unused portion of the previous period. If the subtype is DOWNGRADE, the user downgraded
 29 |      *  their subscription or cross-graded to a subscription with a different duration. Downgrades take effect at the
 30 |      *  next renewal date and don’t affect the currently active plan.
 31 |      *
 32 |      *  If the subtype is empty, the user changed their renewal preference back to the current subscription, effectively
 33 |      *  canceling a downgrade.
 34 |      */
 35 |     const NOTIFICATION_TYPE__DID_CHANGE_RENEWAL_PREF = 'DID_CHANGE_RENEWAL_PREF';
 36 | 
 37 |     /**
 38 |      * A notification type that, along with its subtype, indicates that the user made a change to the subscription
 39 |      * renewal status. If the subtype is AUTO_RENEW_ENABLED, the user re-enabled subscription auto-renewal.
 40 |      * If the subtype is AUTO_RENEW_DISABLED, the user disabled subscription auto-renewal, or the App Store disabled
 41 |      * subscription auto-renewal after the user requested a refund.
 42 |      */
 43 |     const NOTIFICATION_TYPE__DID_CHANGE_RENEWAL_STATUS = 'DID_CHANGE_RENEWAL_STATUS';
 44 | 
 45 |     /**
 46 |      * A notification type that, along with its subtype, indicates that the subscription failed to renew due to a
 47 |      * billing issue. The subscription enters the billing retry period. If the subtype is GRACE_PERIOD, continue to
 48 |      * provide service through the grace period. If the subtype is empty, the subscription isn't in a grace period,
 49 |      * and you can stop providing the subscription service.
 50 |      *
 51 |      * Inform the user that there may be an issue with their billing information. The App Store continues to retry
 52 |      * billing for 60 days, or until the user resolves their billing issue or cancels their subscription, whichever
 53 |      * comes first.
 54 |      */
 55 |     const NOTIFICATION_TYPE__DID_FAIL_TO_RENEW = 'DID_FAIL_TO_RENEW';
 56 | 
 57 |     /**
 58 |      * A notification type that, along with its subtype, indicates that the subscription successfully renewed. If the
 59 |      * subtype is BILLING_RECOVERY, the expired subscription that previously failed to renew has successfully renewed.
 60 |      * If the subtype is empty, the active subscription has successfully auto-renewed for a new transaction period.
 61 |      * Provide the customer with access to the subscription’s content or service.
 62 |      */
 63 |     const NOTIFICATION_TYPE__DID_RENEW = 'DID_RENEW';
 64 | 
 65 |     /**
 66 |      * A notification type that, along with its subtype, indicates that a subscription expired. If the subtype is
 67 |      * VOLUNTARY, the subscription expired after the user disabled subscription renewal. If the subtype is
 68 |      * BILLING_RETRY, the subscription expired because the billing retry period ended without a successful billing
 69 |      * transaction. If the subtype is PRICE_INCREASE, the subscription expired because the user didn't consent to a
 70 |      * price increase that requires user consent. If the subtype is PRODUCT_NOT_FOR_SALE, the subscription expired
 71 |      * because the product wasn't available for purchase at the time the subscription attempted to renew.
 72 |      *
 73 |      * A notification without a subtype indicates that the subscription expired for some other reason.
 74 |      */
 75 |     const NOTIFICATION_TYPE__EXPIRED = 'EXPIRED';
 76 | 
 77 |     /**
 78 |      * A notification type that indicates that the billing grace period has ended without renewing the subscription, so
 79 |      * you can turn off access to the service or content. Inform the user that there may be an issue with their billing
 80 |      * information. The App Store continues to retry billing for 60 days, or until the user resolves their billing issue
 81 |      * or cancels their subscription, whichever comes first.
 82 |      */
 83 |     const NOTIFICATION_TYPE__GRACE_PERIOD_EXPIRED = 'GRACE_PERIOD_EXPIRED';
 84 | 
 85 |     /**
 86 |      * A notification type that, along with its subtype, indicates that the user redeemed a promotional offer or offer
 87 |      * code.
 88 |      *
 89 |      * If the subtype is INITIAL_BUY, the user redeemed the offer for a first-time purchase. If the subtype is
 90 |      * RESUBSCRIBE, the user redeemed an offer to resubscribe to an inactive subscription. If the subtype is UPGRADE,
 91 |      * the user redeemed an offer to upgrade their active subscription, which goes into effect immediately. If the
 92 |      * subtype is DOWNGRADE, the user redeemed an offer to downgrade their active subscription, which goes into effect
 93 |      * at the next renewal date. If the user redeemed an offer for their active subscription, you receive an
 94 |      * OFFER_REDEEMED notification type without a subtype.
 95 |      */
 96 |     const NOTIFICATION_TYPE__OFFER_REDEEMED = 'OFFER_REDEEMED';
 97 | 
 98 |     /**
 99 |      * A notification type that, along with its subtype, indicates that the system has informed the user of an
100 |      * auto-renewable subscription price increase.
101 |      *
102 |      * If the price increase requires user consent, the subtype is PENDING if the user hasn't responded to the price
103 |      * increase, or ACCEPTED if the user has consented to the price increase.
104 |      *
105 |      * If the price increase doesn't require user consent, the subtype is ACCEPTED.
106 |      */
107 |     const NOTIFICATION_TYPE__PRICE_INCREASE = 'PRICE_INCREASE';
108 | 
109 |     /**
110 |      * A notification type that indicates that the App Store successfully refunded a transaction for a consumable in-app
111 |      * purchase, a non-consumable in-app purchase, an auto-renewable subscription, or a non-renewing subscription.
112 |      *
113 |      * The revocationDate contains the timestamp of the refunded transaction. The originalTransactionId and productId
114 |      * identify the original transaction and product. The revocationReason contains the reason.
115 |      *
116 |      * To request a list of all refunded transactions for a user, see `AppStoreServerApi::getRefundHistory()`.
117 |      */
118 |     const NOTIFICATION_TYPE__REFUND = 'REFUND';
119 | 
120 |     /**
121 |      * A notification type that indicates the App Store declined a refund request initiated by the app developer using
122 |      * any of the following methods: beginRefundRequest(for:in:), beginRefundRequest(in:), beginRefundRequest(for:in:),
123 |      * beginRefundRequest(in:), and refundRequestSheet(for:isPresented:onDismiss:).
124 |      */
125 |     const NOTIFICATION_TYPE__REFUND_DECLINED = 'REFUND_DECLINED';
126 | 
127 |     /**
128 |      * A notification type that indicates the App Store reversed a previously granted refund due to a dispute
129 |      * that the customer raised. If your app revoked content or services as a result of the related refund,
130 |      * it needs to reinstate them.
131 |      *
132 |      * This notification type can apply to any in-app purchase type: consumable, non-consumable,
133 |      * non-renewing subscription, and auto-renewable subscription. For auto-renewable subscriptions, the renewal date
134 |      * remains unchanged when the App Store reverses a refund.
135 |      */
136 |     const NOTIFICATION_TYPE__REFUND_REVERSED = 'REFUND_REVERSED';
137 | 
138 |     /**
139 |      * A notification type that indicates the App Store extended the subscription renewal date for a specific
140 |      * subscription. You request subscription-renewal-date extensions by calling Extend a Subscription Renewal Date or
141 |      * Extend Subscription Renewal Dates for All Active Subscribers in the App Store Server API.
142 |      */
143 |     const NOTIFICATION_TYPE__RENEWAL_EXTENDED = 'RENEWAL_EXTENDED';
144 | 
145 |     /**
146 |      * A notification type that, along with its subtype, indicates that the App Store is attempting to extend the
147 |      * subscription renewal date that you request by calling Extend Subscription Renewal Dates for All Active
148 |      * Subscribers.
149 |      *
150 |      * If the subtype is SUMMARY, the App Store completed extending the renewal date for all eligible subscribers. See
151 |      * `ResponseBodyV2::SUBTYPE_SUMMARY` for details. If the subtype is FAILURE, the renewal date extension didn't
152 |      * succeed for a specific subscription. See the `ResponseBodyV2::getAppMetadata()` data for details.
153 |      */
154 |     const NOTIFICATION_TYPE__RENEWAL_EXTENSION = 'RENEWAL_EXTENSION';
155 | 
156 |     /**
157 |      * A notification type that indicates that an in-app purchase the user was entitled to through Family Sharing is no
158 |      * longer available through sharing. The App Store sends this notification when a purchaser disabled Family Sharing
159 |      * for a product, the purchaser (or family member) left the family group, or the purchaser asked for and received a
160 |      * refund. Your app also receives a paymentQueue(_:didRevokeEntitlementsForProductIdentifiers:) call. Family Sharing
161 |      * applies to non-consumable in-app purchases and auto-renewable subscriptions.
162 |      */
163 |     const NOTIFICATION_TYPE__REVOKE = 'REVOKE';
164 | 
165 |     /**
166 |      * A notification type that, along with its subtype, indicates that the user subscribed to a product. If the subtype
167 |      * is INITIAL_BUY, the user either purchased or received access through Family Sharing to the subscription for the
168 |      * first time. If the subtype is RESUBSCRIBE, the user resubscribed or received access through Family Sharing to the
169 |      * same subscription or to another subscription within the same subscription group.
170 |      */
171 |     const NOTIFICATION_TYPE__SUBSCRIBED = 'SUBSCRIBED';
172 | 
173 |     /**
174 |      * A notification type that the App Store server sends when you request it by calling the Request a Test
175 |      * Notification endpoint. Call that endpoint to test whether your server is receiving notifications. You receive
176 |      * this notification only at your request. For troubleshooting information, see
177 |      * `AppStoreServerAPI::getTestNotificationStatus`.
178 |      */
179 |     const NOTIFICATION_TYPE__TEST = 'TEST';
180 | 
181 |     /**
182 |      * Applies to the PRICE_INCREASE notificationType. A notification with this subtype indicates that the user accepted
183 |      * the subscription price increase.
184 |      */
185 |     const SUBTYPE__ACCEPTED = 'ACCEPTED';
186 | 
187 |     /**
188 |      * Applies to the DID_CHANGE_RENEWAL_STATUS notificationType. A notification with this subtype indicates that the
189 |      * user disabled subscription auto-renewal, or the App Store disabled subscription auto-renewal after the user
190 |      * requested a refund.
191 |      */
192 |     const SUBTYPE__AUTO_RENEW_DISABLED = 'AUTO_RENEW_DISABLED';
193 | 
194 |     /**
195 |      * Applies to the DID_CHANGE_RENEWAL_STATUS notificationType. A notification with this subtype indicates that the
196 |      * user enabled subscription auto-renewal.
197 |      */
198 |     const SUBTYPE__AUTO_RENEW_ENABLED = 'AUTO_RENEW_ENABLED';
199 | 
200 |     /**
201 |      * Applies to the DID_RENEW notificationType. A notification with this subtype indicates that the expired
202 |      * subscription that previously failed to renew has successfully renewed.
203 |      */
204 |     const SUBTYPE__BILLING_RECOVERY = 'BILLING_RECOVERY';
205 | 
206 |     /**
207 |      * Applies to the EXPIRED notificationType. A notification with this subtype indicates that the subscription expired
208 |      * because the subscription failed to renew before the billing retry period ended.
209 |      */
210 |     const SUBTYPE__BILLING_RETRY = 'BILLING_RETRY';
211 | 
212 |     /**
213 |      * Applies to the DID_CHANGE_RENEWAL_PREF notificationType. A notification with this subtype indicates that the user
214 |      * downgraded their subscription or cross-graded to a subscription with a different duration. Downgrades take effect
215 |      * at the next renewal date.
216 |      */
217 |     const SUBTYPE__DOWNGRADE = 'DOWNGRADE';
218 | 
219 |     /**
220 |      * Applies to the RENEWAL_EXTENSION notificationType. A notification with this subtype indicates that the
221 |      * subscription-renewal-date extension failed for an individual subscription. For details, see
222 |      * `ResponseBodyV2::getAppMetadata()`. For information on the request, see Extend Subscription Renewal Dates for
223 |      * All Active Subscribers.
224 |      */
225 |     const SUBTYPE__FAILURE = 'FAILURE';
226 | 
227 |     /**
228 |      * Applies to the DID_FAIL_TO_RENEW notificationType. A notification with this subtype indicates that the
229 |      * subscription failed to renew due to a billing issue. Continue to provide access to the subscription during the
230 |      * grace period.
231 |      */
232 |     const SUBTYPE__GRACE_PERIOD = 'GRACE_PERIOD';
233 | 
234 |     /**
235 |      * Applies to the SUBSCRIBED notificationType. A notification with this subtype indicates that the user purchased
236 |      * the subscription for the first time or that the user received access to the subscription through Family Sharing
237 |      * for the first time.
238 |      */
239 |     const SUBTYPE__INITIAL_BUY = 'INITIAL_BUY';
240 | 
241 |     /**
242 |      * Applies to the PRICE_INCREASE notificationType. A notification with this subtype indicates that the system
243 |      * informed the user of the subscription price increase, but the user hasn't accepted it.
244 |      */
245 |     const SUBTYPE__PENDING = 'PENDING';
246 | 
247 |     /**
248 |      * Applies to the EXPIRED notificationType. A notification with this subtype indicates that the subscription expired
249 |      * because the user didn't consent to a price increase.
250 |      */
251 |     const SUBTYPE__PRICE_INCREASE = 'PRICE_INCREASE';
252 | 
253 |     /**
254 |      * Applies to the EXPIRED notificationType. A notification with this subtype indicates that the subscription expired
255 |      * because the product wasn't available for purchase at the time the subscription attempted to renew.
256 |      */
257 |     const SUBTYPE__PRODUCT_NOT_FOR_SALE = 'PRODUCT_NOT_FOR_SALE';
258 | 
259 |     /**
260 |      * Applies to the SUBSCRIBED notificationType. A notification with this subtype indicates that the user resubscribed
261 |      * or received access through Family Sharing to the same subscription or to another subscription within the same
262 |      * subscription group.
263 |      */
264 |     const SUBTYPE__RESUBSCRIBE = 'RESUBSCRIBE';
265 | 
266 |     /**
267 |      * Applies to the RENEWAL_EXTENSION notificationType. A notification with this subtype indicates that the App Store
268 |      * server completed your request to extend the subscription renewal date for all eligible subscribers. For the
269 |      * summary details, see `ResponseBodyV2::getSummary()`. For information on the request, see Extend Subscription
270 |      * Renewal Dates for All Active Subscribers.
271 |      */
272 |     const SUBTYPE__SUMMARY = 'SUMMARY';
273 | 
274 |     /**
275 |      * Applies to the DID_CHANGE_RENEWAL_PREF notificationType. A notification with this subtype indicates that the user
276 |      * upgraded their subscription or cross-graded to a subscription with the same duration. Upgrades take effect
277 |      * immediately.
278 |      */
279 |     const SUBTYPE__UPGRADE = 'UPGRADE';
280 | 
281 |     /**
282 |      * Applies to the EXPIRED notificationType. A notification with this subtype indicates that the subscription expired
283 |      * after the user disabled subscription auto-renewal.
284 |      */
285 |     const SUBTYPE__VOLUNTARY = 'VOLUNTARY';
286 | 
287 |     /**
288 |      * Describes the in-app purchase event that led to this notification.
289 |      */
290 |     private string $notificationType;
291 | 
292 |     /**
293 |      * Additional information that identifies the notification event.
294 |      * The subtype field is present only for specific version 2 notifications.
295 |      */
296 |     private ?string $subtype = null;
297 | 
298 |     /**
299 |      * A unique identifier for the notification.
300 |      */
301 |     private string $notificationUUID;
302 | 
303 |     /**
304 |      * The object that contains the app metadata and signed renewal and transaction information.
305 |      */
306 |     private AppMetadata $appMetadata;
307 | 
308 |     /**
309 |      * A string that indicates the App Store Server Notification version number.
310 |      */
311 |     private string $version;
312 | 
313 |     /**
314 |      * The UNIX time, in milliseconds, that the App Store signed the JSON Web Signature data.
315 |      */
316 |     private int $signedDate;
317 | 
318 |     private function __construct()
319 |     {
320 |         // just a stub which prevents this class from direct instantiation
321 |     }
322 | 
323 |     /**
324 |      * @throws AppStoreServerNotificationException
325 |      */
326 |     public static function createFromRawNotification(string $rawNotification, ?string $rootCertificate = null): self
327 |     {
328 |         $notification = json_decode($rawNotification, true);
329 | 
330 |         if (json_last_error() !== JSON_ERROR_NONE || !is_array($notification)) {
331 |             throw new AppStoreServerNotificationException('Notification is not a valid JSON array');
332 |         }
333 | 
334 |         if (!array_key_exists('signedPayload', $notification)) {
335 |             throw new AppStoreServerNotificationException('Notification does not contain "signedPayload" property');
336 |         }
337 | 
338 |         try {
339 |             $payload = JWT::parse($notification['signedPayload'], $rootCertificate);
340 |         } catch (MalformedJWTException $e) {
341 |             throw new AppStoreServerNotificationException('Malformed JWT: ' . $e->getMessage());
342 |         }
343 | 
344 |         if (!empty($payload['data']['signedRenewalInfo'])) {
345 |             try {
346 |                 $rawRenewalInfo = JWT::parse($payload['data']['signedRenewalInfo'], $rootCertificate);
347 |             } catch (MalformedJWTException $e) {
348 |                 throw new AppStoreServerNotificationException('Malformed RenewalInfo JWT: ' . $e->getMessage());
349 |             }
350 | 
351 |             $payload['data']['renewalInfo'] = RenewalInfo::createFromRawRenewalInfo($rawRenewalInfo);
352 |             unset($payload['data']['signedRenewalInfo']);
353 |         }
354 | 
355 |         if (!empty($payload['data']['signedTransactionInfo'])) {
356 |             try {
357 |                 $rawTransactionInfo = JWT::parse($payload['data']['signedTransactionInfo'], $rootCertificate);
358 |             } catch (MalformedJWTException $e) {
359 |                 throw new AppStoreServerNotificationException('Malformed TransactionInfo JWT: ' . $e->getMessage());
360 |             }
361 | 
362 |             $payload['data']['transactionInfo'] = TransactionInfo::createFromRawTransactionInfo($rawTransactionInfo);
363 |             unset($payload['data']['signedTransactionInfo']);
364 |         }
365 | 
366 |         $responseBodyV2 = new self();
367 |         $responseBodyV2->appMetadata = AppMetadata::createFromRawData($payload['data']);
368 | 
369 |         $typeCaster = Helper::arrayTypeCastGenerator($payload, [
370 |             'int' => ['signedDate'],
371 |             'string' => ['notificationType', 'subtype', 'notificationUUID', 'version'],
372 |         ]);
373 | 
374 |         foreach ($typeCaster as $prop => $value) {
375 |             $responseBodyV2->$prop = $value;
376 |         }
377 | 
378 |         return $responseBodyV2;
379 |     }
380 | 
381 |     /**
382 |      * Returns description of the in-app purchase event that led to this notification.
383 |      *
384 |      * @return self::NOTIFICATION_TYPE__*
385 |      */
386 |     public function getNotificationType(): string
387 |     {
388 |         return $this->notificationType;
389 |     }
390 | 
391 |     /**
392 |      * Returns additional information that identifies the notification event.
393 |      * The subtype field is present only for specific version 2 notifications.
394 |      *
395 |      * @return null|self::SUBTYPE__*
396 |      */
397 |     public function getSubtype(): ?string
398 |     {
399 |         return $this->subtype;
400 |     }
401 | 
402 |     /**
403 |      * Returns a unique identifier for the notification.
404 |      */
405 |     public function getNotificationUUID(): string
406 |     {
407 |         return $this->notificationUUID;
408 |     }
409 | 
410 |     /**
411 |      * Returns the object that contains the app metadata and signed renewal and transaction information.
412 |      */
413 |     public function getAppMetadata(): AppMetadata
414 |     {
415 |         return $this->appMetadata;
416 |     }
417 | 
418 |     /**
419 |      * Returns a string that indicates the App Store Server Notification version number.
420 |      */
421 |     public function getVersion(): string
422 |     {
423 |         return $this->version;
424 |     }
425 | 
426 |     /**
427 |      * Returns the UNIX time, in milliseconds, that the App Store signed the JSON Web Signature data.
428 |      */
429 |     public function getSignedDate(): int
430 |     {
431 |         return $this->signedDate;
432 |     }
433 | 
434 |     /**
435 |      * @return array<string, mixed>
436 |      */
437 |     public function jsonSerialize(): array
438 |     {
439 |         return get_object_vars($this);
440 |     }
441 | }
442 | 


--------------------------------------------------------------------------------