Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | n/a |
0 / 0 |
n/a |
0 / 0 |
CRAP | n/a |
0 / 0 |
|||
| 1 | <?php |
| 2 | declare(strict_types=1); |
| 3 | /** |
| 4 | * Pop PHP Framework (https://www.popphp.org/) |
| 5 | * |
| 6 | * @link https://github.com/popphp/popphp-framework |
| 7 | * @author Nick Sagona, III <dev@noladev.com> |
| 8 | * @copyright Copyright (c) 2009-2027 NOLA Interactive, LLC. |
| 9 | * @license https://www.popphp.org/license New BSD License |
| 10 | */ |
| 11 | |
| 12 | /** |
| 13 | * @namespace |
| 14 | */ |
| 15 | namespace Pop\Shipping\Client; |
| 16 | |
| 17 | use Pop\Http\Client; |
| 18 | |
| 19 | /** |
| 20 | * Pop shipping client interface |
| 21 | * |
| 22 | * @category Pop |
| 23 | * @package Pop\Shipping |
| 24 | * @author Nick Sagona, III <dev@noladev.com> |
| 25 | * @copyright Copyright (c) 2009-2027 NOLA Interactive, LLC. |
| 26 | * @license https://www.popphp.org/license New BSD License |
| 27 | * @version 4.0.0 |
| 28 | */ |
| 29 | interface ShippingClientInterface |
| 30 | { |
| 31 | |
| 32 | /** |
| 33 | * Set the HTTP client |
| 34 | * |
| 35 | * @param Client $client |
| 36 | * @return ShippingClientInterface |
| 37 | */ |
| 38 | public function setClient(Client $client): ShippingClientInterface; |
| 39 | |
| 40 | /** |
| 41 | * Get the HTTP client |
| 42 | * |
| 43 | * @return ?Client |
| 44 | */ |
| 45 | public function getClient(): ?Client; |
| 46 | |
| 47 | /** |
| 48 | * Has HTTP client |
| 49 | * |
| 50 | * @return bool |
| 51 | */ |
| 52 | public function hasClient(): bool; |
| 53 | |
| 54 | /** |
| 55 | * Get API URL |
| 56 | * |
| 57 | * @return ?string |
| 58 | */ |
| 59 | public function getApiUrl(): ?string; |
| 60 | |
| 61 | /** |
| 62 | * Set as production |
| 63 | * |
| 64 | * @param bool $prod |
| 65 | * @return AbstractShippingClient |
| 66 | */ |
| 67 | public function setProduction(bool $prod): ShippingClientInterface; |
| 68 | |
| 69 | /** |
| 70 | * Is production |
| 71 | * |
| 72 | * @return bool |
| 73 | */ |
| 74 | public function isProduction(): bool; |
| 75 | |
| 76 | /** |
| 77 | * Set production API URL |
| 78 | * |
| 79 | * @param string $prodApiUrl |
| 80 | * @return ShippingClientInterface |
| 81 | */ |
| 82 | public function setProdApiUrl(string $prodApiUrl): ShippingClientInterface; |
| 83 | |
| 84 | /** |
| 85 | * Set test API URL |
| 86 | * |
| 87 | * @param string $testApiUrl |
| 88 | * @return ShippingClientInterface |
| 89 | */ |
| 90 | public function setTestApiUrl(string $testApiUrl): ShippingClientInterface; |
| 91 | |
| 92 | /** |
| 93 | * Get production API URL |
| 94 | * |
| 95 | * @return ?string |
| 96 | */ |
| 97 | public function getProdApiUrl(): ?string; |
| 98 | |
| 99 | /** |
| 100 | * Get test API URL |
| 101 | * |
| 102 | * @return ?string |
| 103 | */ |
| 104 | public function getTestApiUrl(): ?string; |
| 105 | |
| 106 | /** |
| 107 | * Has production API URL |
| 108 | * |
| 109 | * @return bool |
| 110 | */ |
| 111 | public function hasProdApiUrl(): bool; |
| 112 | |
| 113 | /** |
| 114 | * Has test API URL |
| 115 | * |
| 116 | * @return bool |
| 117 | */ |
| 118 | public function hasTestApiUrl(): bool; |
| 119 | |
| 120 | } |