AuthenticationApiInterface.php 1.0 KB

12345678910111213141516171819202122232425262728293031323334
  1. <?php
  2. /**
  3. * Refer to LICENSE.txt distributed with the Temando Shipping module for notice of license
  4. */
  5. namespace Temando\Shipping\Rest\Adapter;
  6. use Temando\Shipping\Rest\Exception\AdapterException;
  7. use Temando\Shipping\Rest\Request\AuthRequestInterface;
  8. use Temando\Shipping\Rest\Response\DataObject\Session;
  9. /**
  10. * The Temando Authentication API interface defines the supported subset of
  11. * operations as available at the Temando API.
  12. *
  13. * @package Temando\Shipping\Rest
  14. * @author Christoph Aßmann <christoph.assmann@netresearch.de>
  15. * @author Sebastian Ertner <sebastian.ertner@netresearch.de>
  16. * @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
  17. * @link http://www.temando.com/
  18. */
  19. interface AuthenticationApiInterface
  20. {
  21. /**
  22. * @param AuthRequestInterface $request
  23. * @return Session
  24. * @throws AdapterException
  25. */
  26. public function startSession(AuthRequestInterface $request);
  27. /**
  28. * @return bool
  29. */
  30. public function endSession();
  31. }