give
/
vendor
/
vendor-prefixed
/
stellarwp
/
licensing-api-client
/
src
/
Resources
/
Credit
/
CreditsQuotasResource.php
give
/
vendor
/
vendor-prefixed
/
stellarwp
/
licensing-api-client
/
src
/
Resources
/
Credit
Last commit date
CreditsLedgerResource.php
3 months ago
CreditsPoolsResource.php
3 months ago
CreditsQuotasResource.php
3 months ago
CreditsResource.php
3 months ago
CreditsQuotasResource.php
147 lines
| 1 | <?php declare(strict_types=1); |
| 2 | |
| 3 | namespace Give\Vendors\LiquidWeb\LicensingApiClient\Resources\Credit; |
| 4 | |
| 5 | use JsonException; |
| 6 | use Give\Vendors\LiquidWeb\LicensingApiClient\Exceptions\ApiResponseException; |
| 7 | use Give\Vendors\LiquidWeb\LicensingApiClient\Exceptions\MissingAuthenticationException; |
| 8 | use Give\Vendors\LiquidWeb\LicensingApiClient\Exceptions\UnexpectedResponseException; |
| 9 | use Give\Vendors\LiquidWeb\LicensingApiClient\Http\AuthState; |
| 10 | use Give\Vendors\LiquidWeb\LicensingApiClient\Http\Factories\ApiUriFactory; |
| 11 | use Give\Vendors\LiquidWeb\LicensingApiClient\Http\RequestExecutor; |
| 12 | use Give\Vendors\LiquidWeb\LicensingApiClient\Http\RequestHeaderCollection; |
| 13 | use Give\Vendors\LiquidWeb\LicensingApiClient\Requests\Credit\SetQuota; |
| 14 | use Give\Vendors\LiquidWeb\LicensingApiClient\Resources\Concerns\RebindsAuthState; |
| 15 | use Give\Vendors\LiquidWeb\LicensingApiClient\Resources\Concerns\RebindsRequestHeaderCollection; |
| 16 | use Give\Vendors\LiquidWeb\LicensingApiClient\Resources\Contracts\CreditsQuotasResourceInterface; |
| 17 | use Give\Vendors\LiquidWeb\LicensingApiClient\Responses\Credit\DeleteQuota; |
| 18 | use Give\Vendors\LiquidWeb\LicensingApiClient\Responses\Credit\QuotaCollection; |
| 19 | use Give\Vendors\LiquidWeb\LicensingApiClient\Responses\Credit\ValueObjects\SiteQuota; |
| 20 | use Give\Vendors\Psr\Http\Client\ClientExceptionInterface; |
| 21 | |
| 22 | /** |
| 23 | * Provides operations for the credits quotas API resource. |
| 24 | * |
| 25 | * @phpstan-import-type SetQuotaPayload from \LiquidWeb\LicensingApiClient\Requests\Credit\SetQuota |
| 26 | * @phpstan-type SiteQuotaPayload array{ |
| 27 | * domain: string, |
| 28 | * credit_type: string, |
| 29 | * quota: ?int, |
| 30 | * period: string, |
| 31 | * first_period_start: ?string, |
| 32 | * is_blocked: bool, |
| 33 | * is_uncapped: bool |
| 34 | * } |
| 35 | * @phpstan-type QuotaCollectionPayload array{ |
| 36 | * quotas: list<SiteQuotaPayload> |
| 37 | * } |
| 38 | * @phpstan-type DeleteQuotaPayload array{ |
| 39 | * deleted: bool |
| 40 | * } |
| 41 | */ |
| 42 | final class CreditsQuotasResource implements CreditsQuotasResourceInterface |
| 43 | { |
| 44 | use RebindsAuthState; |
| 45 | use RebindsRequestHeaderCollection; |
| 46 | |
| 47 | private RequestExecutor $requestExecutor; |
| 48 | |
| 49 | private ApiUriFactory $apiUriFactory; |
| 50 | |
| 51 | private AuthState $authState; |
| 52 | |
| 53 | private RequestHeaderCollection $requestHeaderCollection; |
| 54 | |
| 55 | public function __construct( |
| 56 | RequestExecutor $requestExecutor, |
| 57 | ApiUriFactory $apiUriFactory, |
| 58 | AuthState $authState, |
| 59 | RequestHeaderCollection $requestHeaderCollection |
| 60 | ) { |
| 61 | $this->requestExecutor = $requestExecutor; |
| 62 | $this->apiUriFactory = $apiUriFactory; |
| 63 | $this->authState = $authState; |
| 64 | $this->requestHeaderCollection = $requestHeaderCollection; |
| 65 | } |
| 66 | |
| 67 | /** |
| 68 | * @throws ApiResponseException |
| 69 | * @throws MissingAuthenticationException |
| 70 | * @throws UnexpectedResponseException |
| 71 | * @throws ClientExceptionInterface |
| 72 | * @throws JsonException |
| 73 | */ |
| 74 | public function list(string $licenseKey): QuotaCollection { |
| 75 | $result = $this->requestExecutor->executeJson( |
| 76 | 'GET', |
| 77 | $this->apiUriFactory->make('/credits/quotas'), |
| 78 | [ |
| 79 | 'license_key' => $licenseKey, |
| 80 | ], |
| 81 | null, |
| 82 | $this->authState->requiredToken(), |
| 83 | $this->requestHeaderCollection->all() |
| 84 | ); |
| 85 | |
| 86 | /** @var QuotaCollectionPayload $result */ |
| 87 | return QuotaCollection::from($result); |
| 88 | } |
| 89 | |
| 90 | /** |
| 91 | * @throws ApiResponseException |
| 92 | * @throws MissingAuthenticationException |
| 93 | * @throws UnexpectedResponseException |
| 94 | * @throws ClientExceptionInterface |
| 95 | * @throws JsonException |
| 96 | */ |
| 97 | public function set(SetQuota $request): SiteQuota { |
| 98 | /** @var SetQuotaPayload $body */ |
| 99 | $body = $request->toArray(); |
| 100 | |
| 101 | $result = $this->requestExecutor->executeJson( |
| 102 | 'POST', |
| 103 | $this->apiUriFactory->make('/credits/quotas'), |
| 104 | [], |
| 105 | $body, |
| 106 | $this->authState->requiredToken(), |
| 107 | $this->requestHeaderCollection->all() |
| 108 | ); |
| 109 | |
| 110 | /** @var SiteQuotaPayload $result */ |
| 111 | return SiteQuota::from($result); |
| 112 | } |
| 113 | |
| 114 | /** |
| 115 | * @throws ApiResponseException |
| 116 | * @throws MissingAuthenticationException |
| 117 | * @throws UnexpectedResponseException |
| 118 | * @throws ClientExceptionInterface |
| 119 | * @throws JsonException |
| 120 | */ |
| 121 | public function delete(string $licenseKey, string $domain, string $creditType): DeleteQuota { |
| 122 | $result = $this->requestExecutor->executeJson( |
| 123 | 'DELETE', |
| 124 | $this->apiUriFactory->make('/credits/quotas'), |
| 125 | [], |
| 126 | [ |
| 127 | 'license_key' => $licenseKey, |
| 128 | 'domain' => $domain, |
| 129 | 'credit_type' => $creditType, |
| 130 | ], |
| 131 | $this->authState->requiredToken(), |
| 132 | $this->requestHeaderCollection->all() |
| 133 | ); |
| 134 | |
| 135 | /** @var DeleteQuotaPayload $result */ |
| 136 | return DeleteQuota::from($result); |
| 137 | } |
| 138 | |
| 139 | protected function rebindWithAuthState(AuthState $authState): self { |
| 140 | return new self($this->requestExecutor, $this->apiUriFactory, $authState, $this->requestHeaderCollection); |
| 141 | } |
| 142 | |
| 143 | protected function rebindWithRequestHeaderCollection(RequestHeaderCollection $requestHeaderCollection): self { |
| 144 | return new self($this->requestExecutor, $this->apiUriFactory, $this->authState, $requestHeaderCollection); |
| 145 | } |
| 146 | } |
| 147 |