* @phpstan-type ValidatePayload array{ * license: array{license_key: string, status: string}|null, * domain: string, * is_production: bool, * products: list * }|null, * activation: array{ * domain: string, * activated_at: string * }|null, * available_entitlements?: list, * status: string, * expires: string * }> * }> * } * @phpstan-type ListingPayload array{ * licenses: list, * activations: array{ * site_limit: int, * active_count: int, * over_limit: bool, * excess_activations: int, * domains: ActivationDomainsPayload * } * }>, * aliases: list * }>, * links: array{ * first: string, * last: string|null, * prev: string|null, * next: string|null * }, * meta: array{ * page: array{ * total: int, * limit: int, * max_size: int * } * } * } * @phpstan-import-type ActivatePayload from ActivateRequest * @phpstan-import-type DeactivatePayload from DeactivateRequest * @phpstan-import-type DeleteActivationPayload from DeleteActivationRequest * @phpstan-import-type LicenseReferencePayload from LicenseReference * @phpstan-import-type RegenerateKeyPayload from RegenerateKeyRequest * @phpstan-import-type ImportAliasesPayload from ImportAliasesRequest * @phpstan-import-type RemoveAliasesPayload from RemoveAliasesRequest * @phpstan-type ActivateResponsePayload array{ * status: string, * is_valid: bool, * is_production: bool, * license: array{license_key: string, status: string}|null, * entitlement: array{ * product_slug: string, * tier: string, * site_limit: int, * active_count: int, * available: int, * over_limit: bool, * excess_activations: int, * expiration_date: string, * status: string, * capabilities: list * }|null, * activation: array{ * domain: string, * activated_at: string * }|null * } * @phpstan-type DeactivateResponsePayload array{deactivated: bool} * @phpstan-type DeleteActivationResponsePayload array{deleted: bool} * @phpstan-type StatusChangePayload array{license_key: string, status: string} * @phpstan-type RegenerateKeyResponsePayload array{license_key: string} * @phpstan-type ImportAliasesResponsePayload array{ * imported: list * } * @phpstan-type RemoveAliasesResponsePayload array{removed: int} */ final class LicensesResource implements LicensesResourceInterface { use RebindsAuthState; use RebindsRequestHeaderCollection; private RequestExecutor $requestExecutor; private ApiUriFactory $apiUriFactory; private AuthState $authState; private RequestHeaderCollection $requestHeaderCollection; public function __construct( RequestExecutor $requestExecutor, ApiUriFactory $apiUriFactory, AuthState $authState, RequestHeaderCollection $requestHeaderCollection ) { $this->requestExecutor = $requestExecutor; $this->apiUriFactory = $apiUriFactory; $this->authState = $authState; $this->requestHeaderCollection = $requestHeaderCollection; } /** * @throws ApiErrorExceptionInterface * @throws MissingAuthenticationException * @throws UnexpectedResponseException * @throws ClientExceptionInterface * @throws JsonException */ public function activate(ActivateRequest $request): Activate { /** @var ActivatePayload $body */ $body = $request->toArray(); $result = $this->requestExecutor->executeJson( 'POST', $this->apiUriFactory->make('/licenses/activate'), [], $body, $this->authState->requiredToken(), $this->requestHeaderCollection->all() ); /** @var ActivateResponsePayload $result */ return Activate::from($result); } /** * @throws ApiErrorExceptionInterface * @throws MissingAuthenticationException * @throws UnexpectedResponseException * @throws ClientExceptionInterface * @throws JsonException */ public function deactivate(DeactivateRequest $request): Deactivate { /** @var DeactivatePayload $body */ $body = $request->toArray(); $result = $this->requestExecutor->executeJson( 'POST', $this->apiUriFactory->make('/licenses/deactivate'), [], $body, $this->authState->requiredToken(), $this->requestHeaderCollection->all() ); /** @var DeactivateResponsePayload $result */ return Deactivate::from($result); } /** * @throws ApiErrorExceptionInterface * @throws MissingAuthenticationException * @throws UnexpectedResponseException * @throws ClientExceptionInterface * @throws JsonException */ public function deleteActivation(DeleteActivationRequest $request): DeleteActivation { /** @var DeleteActivationPayload $body */ $body = $request->toArray(); $result = $this->requestExecutor->executeJson( 'DELETE', $this->apiUriFactory->make('/licenses/activation'), [], $body, $this->authState->requiredToken(), $this->requestHeaderCollection->all() ); /** @var DeleteActivationResponsePayload $result */ return DeleteActivation::from($result); } /** * @throws ApiErrorExceptionInterface * @throws MissingAuthenticationException * @throws UnexpectedResponseException * @throws ClientExceptionInterface * @throws JsonException */ public function list(ListRequest $request): Listing { $result = $this->requestExecutor->executeJson( 'GET', $this->apiUriFactory->make('/licenses'), $request->toQuery(), null, $this->authState->requiredToken(), $this->requestHeaderCollection->all() ); /** @var ListingPayload $result */ return Listing::from($result); } /** * @throws ApiErrorExceptionInterface * @throws MissingAuthenticationException * @throws UnexpectedResponseException * @throws ClientExceptionInterface * @throws JsonException * * @return Generator */ public function pages(ListRequest $request): Generator { $page = $this->list($request); while (true) { yield $page; if ($page->links->next === null) { return; } $result = $this->requestExecutor->executeJson( 'GET', $this->apiUriFactory->fromPaginationLink($page->links->next), [], null, $this->authState->requiredToken(), $this->requestHeaderCollection->all() ); /** @var ListingPayload $result */ $page = Listing::from($result); } } /** * @param list $productSlugs * * @throws ApiErrorExceptionInterface * @throws MissingAuthenticationException * @throws UnexpectedResponseException * @throws ClientExceptionInterface * @throws JsonException */ public function validate(string $licenseKey, array $productSlugs, string $domain): Validate { $result = $this->requestExecutor->executeJson( 'GET', $this->apiUriFactory->make('/licenses/validate'), [ 'license_key' => $licenseKey, 'product_slugs' => $productSlugs, 'domain' => $domain, ], null, $this->authState->optionalToken(), $this->requestHeaderCollection->all() ); /** @var ValidatePayload $result */ return Validate::from($result); } /** * @throws ApiErrorExceptionInterface * @throws MissingAuthenticationException * @throws UnexpectedResponseException * @throws ClientExceptionInterface * @throws JsonException */ public function suspend(LicenseReference $request): StatusChange { return $this->changeLicenseStatus('/licenses/suspend', $request); } /** * @throws ApiErrorExceptionInterface * @throws MissingAuthenticationException * @throws UnexpectedResponseException * @throws ClientExceptionInterface * @throws JsonException */ public function reinstate(LicenseReference $request): StatusChange { return $this->changeLicenseStatus('/licenses/reinstate', $request); } /** * @throws ApiErrorExceptionInterface * @throws MissingAuthenticationException * @throws UnexpectedResponseException * @throws ClientExceptionInterface * @throws JsonException */ public function ban(LicenseReference $request): StatusChange { return $this->changeLicenseStatus('/licenses/ban', $request); } /** * @throws ApiErrorExceptionInterface * @throws MissingAuthenticationException * @throws UnexpectedResponseException * @throws ClientExceptionInterface * @throws JsonException */ public function regenerateKey(RegenerateKeyRequest $request): RegenerateKey { /** @var RegenerateKeyPayload $body */ $body = $request->toArray(); $result = $this->requestExecutor->executeJson( 'POST', $this->apiUriFactory->make('/licenses/regenerate-key'), [], $body, $this->authState->requiredToken(), $this->requestHeaderCollection->all() ); /** @var RegenerateKeyResponsePayload $result */ return RegenerateKey::from($result); } /** * @throws ApiErrorExceptionInterface * @throws MissingAuthenticationException * @throws UnexpectedResponseException * @throws ClientExceptionInterface * @throws JsonException */ public function importAliases(ImportAliasesRequest $request): ImportAliases { /** @var ImportAliasesPayload $body */ $body = $request->toArray(); $result = $this->requestExecutor->executeJson( 'POST', $this->apiUriFactory->make('/licenses/aliases'), [], $body, $this->authState->requiredToken(), $this->requestHeaderCollection->all() ); /** @var ImportAliasesResponsePayload $result */ return ImportAliases::from($result); } /** * @throws ApiErrorExceptionInterface * @throws MissingAuthenticationException * @throws UnexpectedResponseException * @throws ClientExceptionInterface * @throws JsonException */ public function removeAliases(RemoveAliasesRequest $request): RemoveAliases { /** @var RemoveAliasesPayload $body */ $body = $request->toArray(); $result = $this->requestExecutor->executeJson( 'DELETE', $this->apiUriFactory->make('/licenses/aliases'), [], $body, $this->authState->requiredToken(), $this->requestHeaderCollection->all() ); /** @var RemoveAliasesResponsePayload $result */ return RemoveAliases::from($result); } protected function rebindWithAuthState(AuthState $authState): self { return new self($this->requestExecutor, $this->apiUriFactory, $authState, $this->requestHeaderCollection); } protected function rebindWithRequestHeaderCollection(RequestHeaderCollection $requestHeaderCollection): self { return new self($this->requestExecutor, $this->apiUriFactory, $this->authState, $requestHeaderCollection); } /** * @throws ApiErrorExceptionInterface * @throws MissingAuthenticationException * @throws UnexpectedResponseException * @throws ClientExceptionInterface * @throws JsonException */ private function changeLicenseStatus(string $path, LicenseReference $request): StatusChange { /** @var LicenseReferencePayload $body */ $body = $request->toArray(); $result = $this->requestExecutor->executeJson( 'POST', $this->apiUriFactory->make($path), [], $body, $this->authState->requiredToken(), $this->requestHeaderCollection->all() ); /** @var StatusChangePayload $result */ return StatusChange::from($result); } }