ConfigurationInterface.php 1.37 KB
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
<?php

/**
 * @copyright  Vertex. All rights reserved.  https://www.vertexinc.com/
 * @author     Mediotype Development         <diveinto@mediotype.com>
 */

namespace Vertex\Data;

/**
 * Contains the configuration for interacting with Vertex
 *
 * @api
 */
interface ConfigurationInterface
{
    /**
     * Retrieve the configured Login object
     *
     * @return LoginInterface|null
     */
    public function getLogin();

    /**
     * Retrieve the URL configured for performing Tax Area Lookup requests
     *
     * @return string|null
     */
    public function getTaxAreaLookupWsdl();

    /**
     * Retrieve the URL configured for performing Tax Calculation requests
     *
     * @return string|null
     */
    public function getTaxCalculationWsdl();

    /**
     * Set a Login object to use when authenticating against Vertex APIs
     *
     * @param LoginInterface $login
     * @return ConfigurationInterface
     */
    public function setLogin(LoginInterface $login);

    /**
     * Set the URL to use when performing Tax Area Lookup requests
     *
     * @param string $url
     * @return ConfigurationInterface
     */
    public function setTaxAreaLookupWsdl($url);

    /**
     * Set the URL to use when performing Tax Calculation requests
     *
     * @param string $url
     * @return ConfigurationInterface
     */
    public function setTaxCalculationWsdl($url);
}