ContainerApiInterface.php 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839
  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\ItemRequestInterface;
  8. use Temando\Shipping\Rest\Request\ListRequestInterface;
  9. use Temando\Shipping\Rest\Response\DataObject\Container;
  10. /**
  11. * The Temando Container API interface defines the supported subset of operations
  12. * as available at the Temando API.
  13. *
  14. * @package Temando\Shipping\Rest
  15. * @author Benjamin Heuer <benjamin.heuer@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 ContainerApiInterface
  20. {
  21. /**
  22. * @param ListRequestInterface $request
  23. *
  24. * @return Container[]
  25. * @throws AdapterException
  26. */
  27. public function getContainers(ListRequestInterface $request);
  28. /**
  29. * @param ItemRequestInterface $request
  30. *
  31. * @return void
  32. * @throws AdapterException
  33. */
  34. public function deleteContainer(ItemRequestInterface $request);
  35. }