<?php
namespace MailChannels;

interface InboundApi {

    /**
     * @param $domain
     * @param $subscriptionHandle
     * @return WHM\Domain
     * @throws InboundApiException
     */
    public function provisionDomain($domain, $subscriptionHandle);

    /**
     * @param $domain
     * @throws InboundApiException
     */
    public function deprovisionDomain($domain);

    public function getSubscriptions();

    public function getDomains($domains);

    /**
     * @param $domain
     * @param $limit
     * @param $offset
     * @return DownstreamAddress[]
     * @throws InboundApiConnectException
     * @throws InboundApiInternalServerErrorException
     * @throws InboundApiNotFoundException
     * @throws InboundApiUnauthorizedException
     */
    public function getDownstreamAddresses($domain, $limit=null, $offset=null);

    /**
     * @param $domain string
     * @param $records DownstreamAddress[]
     * @throws InboundApiUnauthorizedException
     * @throws InboundApiConflictException
     * @throws InboundApiInternalServerErrorException
     * @throws InboundApiException
     */
    public function setDownstreamAddresses($domain, $records);
}