give
/
vendor
/
vendor-prefixed
/
stellarwp
/
licensing-api-client
/
src
/
Resources
/
Credit
/
CreditsResource.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
CreditsResource.php
241 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\RecordUsage as RecordUsageRequest; |
| 14 | use Give\Vendors\LiquidWeb\LicensingApiClient\Requests\Credit\Refund as RefundRequest; |
| 15 | use Give\Vendors\LiquidWeb\LicensingApiClient\Resources\Concerns\RebindsAuthState; |
| 16 | use Give\Vendors\LiquidWeb\LicensingApiClient\Resources\Concerns\RebindsRequestHeaderCollection; |
| 17 | use Give\Vendors\LiquidWeb\LicensingApiClient\Resources\Contracts\CreditsLedgerResourceInterface; |
| 18 | use Give\Vendors\LiquidWeb\LicensingApiClient\Resources\Contracts\CreditsPoolsResourceInterface; |
| 19 | use Give\Vendors\LiquidWeb\LicensingApiClient\Resources\Contracts\CreditsQuotasResourceInterface; |
| 20 | use Give\Vendors\LiquidWeb\LicensingApiClient\Resources\Contracts\CreditsResourceInterface; |
| 21 | use Give\Vendors\LiquidWeb\LicensingApiClient\Responses\Credit\BalanceCollection; |
| 22 | use Give\Vendors\LiquidWeb\LicensingApiClient\Responses\Credit\RecordUsage; |
| 23 | use Give\Vendors\LiquidWeb\LicensingApiClient\Responses\Credit\Refund; |
| 24 | use Give\Vendors\Psr\Http\Client\ClientExceptionInterface; |
| 25 | |
| 26 | /** |
| 27 | * Provides operations for the credits API resource. |
| 28 | * |
| 29 | * @phpstan-type BalancePayload array{ |
| 30 | * credits: list<array{ |
| 31 | * credit_type: string, |
| 32 | * remaining: int, |
| 33 | * site_quota: int|null, |
| 34 | * site_used: int, |
| 35 | * site_remaining: int, |
| 36 | * aggregate_total: int, |
| 37 | * aggregate_used: int, |
| 38 | * aggregate_remaining: int, |
| 39 | * aggregate_overage: int, |
| 40 | * pools: list<array{ |
| 41 | * pool_id: int, |
| 42 | * pool_remaining: int, |
| 43 | * priority: int, |
| 44 | * period: string, |
| 45 | * resets_on: string|null, |
| 46 | * expires_at: string|null, |
| 47 | * credits_total?: int, |
| 48 | * credits_used?: int, |
| 49 | * overage?: int, |
| 50 | * overage_limit?: int|null |
| 51 | * }> |
| 52 | * }> |
| 53 | * } |
| 54 | * @phpstan-import-type RecordUsagePayload from RecordUsageRequest |
| 55 | * @phpstan-import-type RefundPayload from RefundRequest |
| 56 | * @phpstan-type RecordUsageResponsePayload array{ |
| 57 | * credits_used: int, |
| 58 | * pool_remaining: int, |
| 59 | * site_remaining: int|null, |
| 60 | * pool_breakdown: array<array-key, int> |
| 61 | * } |
| 62 | * @phpstan-type RefundResponsePayload array{ |
| 63 | * credits_refunded: int, |
| 64 | * pool_remaining: int, |
| 65 | * site_remaining: int|null, |
| 66 | * pool_breakdown: array<array-key, int> |
| 67 | * } |
| 68 | */ |
| 69 | final class CreditsResource implements CreditsResourceInterface |
| 70 | { |
| 71 | use RebindsAuthState; |
| 72 | use RebindsRequestHeaderCollection; |
| 73 | |
| 74 | private RequestExecutor $requestExecutor; |
| 75 | |
| 76 | private ApiUriFactory $apiUriFactory; |
| 77 | |
| 78 | private AuthState $authState; |
| 79 | |
| 80 | private RequestHeaderCollection $requestHeaderCollection; |
| 81 | |
| 82 | private CreditsPoolsResource $pools; |
| 83 | |
| 84 | private CreditsQuotasResource $quotas; |
| 85 | |
| 86 | private CreditsLedgerResource $ledger; |
| 87 | |
| 88 | public function __construct( |
| 89 | RequestExecutor $requestExecutor, |
| 90 | ApiUriFactory $apiUriFactory, |
| 91 | AuthState $authState, |
| 92 | RequestHeaderCollection $requestHeaderCollection, |
| 93 | CreditsPoolsResource $pools, |
| 94 | CreditsQuotasResource $quotas, |
| 95 | CreditsLedgerResource $ledger |
| 96 | ) { |
| 97 | $this->requestExecutor = $requestExecutor; |
| 98 | $this->apiUriFactory = $apiUriFactory; |
| 99 | $this->authState = $authState; |
| 100 | $this->requestHeaderCollection = $requestHeaderCollection; |
| 101 | $this->pools = $pools; |
| 102 | $this->quotas = $quotas; |
| 103 | $this->ledger = $ledger; |
| 104 | } |
| 105 | |
| 106 | /** |
| 107 | * @throws ApiResponseException |
| 108 | * @throws MissingAuthenticationException |
| 109 | * @throws UnexpectedResponseException |
| 110 | * @throws ClientExceptionInterface |
| 111 | * @throws JsonException |
| 112 | */ |
| 113 | public function balance(string $licenseKey, string $domain, ?string $creditType = null, ?string $sort = null): BalanceCollection { |
| 114 | $result = $this->requestExecutor->executeJson( |
| 115 | 'GET', |
| 116 | $this->apiUriFactory->make('/credits'), |
| 117 | array_filter([ |
| 118 | 'license_key' => $licenseKey, |
| 119 | 'domain' => $domain, |
| 120 | 'credit_type' => $creditType, |
| 121 | 'sort' => $sort, |
| 122 | ], static fn ($value): bool => $value !== null), |
| 123 | null, |
| 124 | $this->authState->optionalToken(), |
| 125 | $this->requestHeaderCollection->all() |
| 126 | ); |
| 127 | |
| 128 | /** @var BalancePayload $result */ |
| 129 | return BalanceCollection::from($result); |
| 130 | } |
| 131 | |
| 132 | /** |
| 133 | * @throws ApiResponseException |
| 134 | * @throws MissingAuthenticationException |
| 135 | * @throws UnexpectedResponseException |
| 136 | * @throws ClientExceptionInterface |
| 137 | * @throws JsonException |
| 138 | */ |
| 139 | public function recordUsage(RecordUsageRequest $request): RecordUsage { |
| 140 | /** @var RecordUsagePayload $body */ |
| 141 | $body = $request->toArray(); |
| 142 | |
| 143 | $result = $this->requestExecutor->executeJson( |
| 144 | 'POST', |
| 145 | $this->apiUriFactory->make('/credits/usage'), |
| 146 | [], |
| 147 | $body, |
| 148 | $this->authState->requiredToken(), |
| 149 | $this->requestHeaderCollection->merge([ |
| 150 | 'X-Idempotency-Key' => $request->idempotencyKey, |
| 151 | ]) |
| 152 | ); |
| 153 | |
| 154 | /** @var RecordUsageResponsePayload $result */ |
| 155 | return RecordUsage::from($result); |
| 156 | } |
| 157 | |
| 158 | /** |
| 159 | * @throws ApiResponseException |
| 160 | * @throws MissingAuthenticationException |
| 161 | * @throws UnexpectedResponseException |
| 162 | * @throws ClientExceptionInterface |
| 163 | * @throws JsonException |
| 164 | */ |
| 165 | public function refund(RefundRequest $request): Refund { |
| 166 | /** @var RefundPayload $body */ |
| 167 | $body = $request->toArray(); |
| 168 | |
| 169 | $result = $this->requestExecutor->executeJson( |
| 170 | 'POST', |
| 171 | $this->apiUriFactory->make('/credits/refunds'), |
| 172 | [], |
| 173 | $body, |
| 174 | $this->authState->requiredToken(), |
| 175 | $this->requestHeaderCollection->merge([ |
| 176 | 'X-Idempotency-Key' => $request->idempotencyKey, |
| 177 | ]) |
| 178 | ); |
| 179 | |
| 180 | /** @var RefundResponsePayload $result */ |
| 181 | return Refund::from($result); |
| 182 | } |
| 183 | |
| 184 | /** |
| 185 | * @throws ApiResponseException |
| 186 | * @throws MissingAuthenticationException |
| 187 | * @throws UnexpectedResponseException |
| 188 | * @throws ClientExceptionInterface |
| 189 | * @throws JsonException |
| 190 | */ |
| 191 | public function pools(): CreditsPoolsResourceInterface { |
| 192 | return $this->pools; |
| 193 | } |
| 194 | |
| 195 | /** |
| 196 | * @throws ApiResponseException |
| 197 | * @throws MissingAuthenticationException |
| 198 | * @throws UnexpectedResponseException |
| 199 | * @throws ClientExceptionInterface |
| 200 | * @throws JsonException |
| 201 | */ |
| 202 | public function quotas(): CreditsQuotasResourceInterface { |
| 203 | return $this->quotas; |
| 204 | } |
| 205 | |
| 206 | /** |
| 207 | * @throws ApiResponseException |
| 208 | * @throws MissingAuthenticationException |
| 209 | * @throws UnexpectedResponseException |
| 210 | * @throws ClientExceptionInterface |
| 211 | * @throws JsonException |
| 212 | */ |
| 213 | public function ledger(): CreditsLedgerResourceInterface { |
| 214 | return $this->ledger; |
| 215 | } |
| 216 | |
| 217 | protected function rebindWithAuthState(AuthState $authState): self { |
| 218 | return new self( |
| 219 | $this->requestExecutor, |
| 220 | $this->apiUriFactory, |
| 221 | $authState, |
| 222 | $this->requestHeaderCollection, |
| 223 | $this->pools->withAuthState($authState), |
| 224 | $this->quotas->withAuthState($authState), |
| 225 | $this->ledger->withAuthState($authState) |
| 226 | ); |
| 227 | } |
| 228 | |
| 229 | protected function rebindWithRequestHeaderCollection(RequestHeaderCollection $requestHeaderCollection): self { |
| 230 | return new self( |
| 231 | $this->requestExecutor, |
| 232 | $this->apiUriFactory, |
| 233 | $this->authState, |
| 234 | $requestHeaderCollection, |
| 235 | $this->pools->withRequestHeaderCollection($requestHeaderCollection), |
| 236 | $this->quotas->withRequestHeaderCollection($requestHeaderCollection), |
| 237 | $this->ledger->withRequestHeaderCollection($requestHeaderCollection) |
| 238 | ); |
| 239 | } |
| 240 | } |
| 241 |