give / vendor / vendor-prefixed / stellarwp / licensing-api-client / src / Resources / Contracts / CreditsLedgerResourceInterface.php

CreditsLedgerResourceInterface.php in GiveWP – Donation Plugin and Fundraising Platform 4.17.0, at vendor/vendor-prefixed/stellarwp/licensing-api-client/src/Resources/Contracts/CreditsLedgerResourceInterface.php

39 lines 1.3 KB

Raw Download Zip

1	<?php declare(strict_types=1);
2
3	namespace Give\Vendors\LiquidWeb\LicensingApiClient\Resources\Contracts;
4
5	use Generator;
6	use JsonException;
7	use Give\Vendors\LiquidWeb\LicensingApiClient\Exceptions\Contracts\ApiErrorExceptionInterface;
8	use Give\Vendors\LiquidWeb\LicensingApiClient\Exceptions\MissingAuthenticationException;
9	use Give\Vendors\LiquidWeb\LicensingApiClient\Exceptions\UnexpectedResponseException;
10	use Give\Vendors\LiquidWeb\LicensingApiClient\Requests\Credit\ListLedgerEntries;
11	use Give\Vendors\LiquidWeb\LicensingApiClient\Responses\Credit\LedgerPage;
12	use Give\Vendors\Psr\Http\Client\ClientExceptionInterface;
13
14	/**
15	* Defines the credits ledger resource surface.
16	*/
17	interface CreditsLedgerResourceInterface
18	{
19	/**
20	* @throws ApiErrorExceptionInterface
21	* @throws MissingAuthenticationException
22	* @throws UnexpectedResponseException
23	* @throws ClientExceptionInterface
24	* @throws JsonException
25	*/
26	public function list(ListLedgerEntries $request): LedgerPage;
27
28	/**
29	* @throws ApiErrorExceptionInterface
30	* @throws MissingAuthenticationException
31	* @throws UnexpectedResponseException
32	* @throws ClientExceptionInterface
33	* @throws JsonException
34	*
35	* @return Generator<int, LedgerPage, mixed, void>
36	*/
37	public function pages(ListLedgerEntries $request): Generator;
38	}
39