ClientInterface.php 1.3 KB

1234567891011121314151617181920212223242526272829303132333435
  1. <?php
  2. /**
  3. * @copyright Vertex. All rights reserved. https://www.vertexinc.com/
  4. * @author Mediotype https://www.mediotype.com/
  5. */
  6. namespace Vertex\Tax\Api;
  7. use Magento\Sales\Api\Data\OrderInterface;
  8. /**
  9. * Service contract for calls against the Vertex API
  10. *
  11. * Recommended usage of this class is for modifying the request or response to Vertex
  12. *
  13. * @api
  14. * @see TaxAreaLookupInterface Tax Area Lookup Service - for looking up tax areas & addresses
  15. * @see InvoiceInterface Invoice Service - for recording invoices against the tax log
  16. * @see QuoteInterface Quotation Service - for getting taxation quotations
  17. * @deprecated Please use the request specific services mentioned in the @see annotations
  18. */
  19. interface ClientInterface
  20. {
  21. /**
  22. * Perform a SOAP call against Vertex
  23. *
  24. * @param array $request A properly formatted SOAP request object. Please consult Vertex API documentation for
  25. * more information
  26. * @param string $type One of tax_area_lookup, invoice, or quote
  27. * @param OrderInterface|null $order The order being invoiced or quoted; null if not applicable
  28. *
  29. * @return array|boolean A SOAP formatted response or false on failure
  30. */
  31. public function sendApiRequest(array $request, $type, OrderInterface $order = null);
  32. }