<?php

require_once dirname(__FILE__).'/class/base_classes.php';

/**
 * Class to access general resources from the create send API.
 * @author tobyb
 *
 */
class OP_CS_REST_General extends OP_CS_REST_Wrapper_Base {

    /**
     * Get the authorization URL for your application, given the application's
     * Client ID, Client Secret, Redirect URI, Scope, and optional state data.
     *
     * @param $client_id int The Client ID of your registered OAuth application.
     * @param $redirect_uri string The Redirect URI of your registered OAuth application.
     * @param $scope string The comma-separated permission scope your application requires.
     *        See http://www.campaignmonitor.com/api/getting-started/#authenticating_with_oauth for details.
     * @param $state string Optional state data to be included in the URL.
     * @return string The authorization URL to which users of your application should be redirected.
     * @access public
     **/
    public static function authorize_url(
        $client_id, $redirect_uri, $scope, $state = NULL) {
        $qs = "client_id=".urlencode($client_id);
        $qs .= "&redirect_uri=".urlencode($redirect_uri);
        $qs .= "&scope=".urlencode($scope);
        if ($state) {
            $qs .= "&state=".urlencode($state);
        }
        return CS_OAUTH_BASE_URI.'?'.$qs;
    }

    /**
     * Exchange a provided OAuth code for an OAuth access token, 'expires in'
     * value and refresh token.
     *
     * @param $client_id int The Client ID of your registered OAuth application.
     * @param $client_secret string The Client Secret of your registered OAuth application.
     * @param $redirect_uri string The Redirect URI of your registered OAuth application.
     * @param $code string The unique OAuth code to be exchanged for an access token.
     * @return OP_CS_REST_Wrapper_Result A successful response will be an object of the form
     * {
     *     'access_token' => The access token to use for API calls
     *     'expires_in' => The number of seconds until this access token expires
     *     'refresh_token' => The refresh token to refresh the access token once it expires
     * }
     * @access public
     **/
    public static function exchange_token(
        $client_id, $client_secret, $redirect_uri, $code) {

        $body = "grant_type=authorization_code";
        $body .= "&client_id=".urlencode($client_id);
        $body .= "&client_secret=".urlencode($client_secret);
        $body .= "&redirect_uri=".urlencode($redirect_uri);
        $body .= "&code=".urlencode($code);

        $options = array('contentType' => 'application/x-www-form-urlencoded');

        $wrap = new OP_CS_REST_Wrapper_Base(
            NULL, 'https', CS_REST_LOG_NONE, CS_HOST, NULL,
            new OP_CS_REST_DoNothingSerialiser(), NULL);

        return $wrap->post_request(CS_OAUTH_TOKEN_URI, $body, $options);
    }

    /**
     * Constructor.
     * @param $auth_details array Authentication details to use for API calls.
     *        This array must take one of the following forms:
     *        If using OAuth to authenticate:
     *        array(
     *          'access_token' => 'your access token',
     *          'refresh_token' => 'your refresh token')
     *
     *        Or if using an API key:
     *        array('api_key' => 'your api key')
     * @param $protocol string The protocol to use for requests (http|https)
     * @param $debug_level int The level of debugging required CS_REST_LOG_NONE | CS_REST_LOG_ERROR | CS_REST_LOG_WARNING | CS_REST_LOG_VERBOSE
     * @param $host string The host to send API requests to. There is no need to change this
     * @param $log OP_CS_REST_Log The logger to use. Used for dependency injection
     * @param $serialiser The serialiser to use. Used for dependency injection
     * @param $transport The transport to use. Used for dependency injection
     * @access public
     */
    function OP_CS_REST_Wrapper_Base(
        $auth_details,
        $protocol = 'https',
        $debug_level = CS_REST_LOG_NONE,
        $host = 'api.createsend.com',
        $log = NULL,
        $serialiser = NULL,
        $transport = NULL) {
        $this->OP_CS_REST_Wrapper_Base($auth_details, $protocol, $debug_level, $host, $log, $serialiser, $transport);        
    }

    /**
     * Gets an array of valid timezones
     * @access public
     * @return OP_CS_REST_Wrapper_Result A successful response will be an object of the form
     * array<string>(timezones)
     */
    function get_timezones() {
        return $this->get_request($this->_base_route.'timezones.json');
    }

    /**
     * Gets the current date in your accounts timezone
     * @access public
     * @return OP_CS_REST_Wrapper_Result A successful response will be an object of the form
     * {
     *     'SystemDate' => string The current system date in your accounts timezone
     * }
     */
    function get_systemdate() {
        return $this->get_request($this->_base_route.'systemdate.json');
    }

    /**
     * Gets an array of valid countries
     * @access public
     * @return OP_CS_REST_Wrapper_Result A successful response will be an object of the form
     * array<string>(countries)
     */
    function get_countries() {
        return $this->get_request($this->_base_route.'countries.json');
    }

    /**
     * Gets your API key
     * @param string $username Your username
     * @param string $password Your password
     * @param string $site_url The url you use to login from
     * @access public
     * @return OP_CS_REST_Wrapper_Result A successful response will be an object of the form
     * {
     *     'ApiKey' => string Your api key
     * }
     */
    function get_apikey($username, $password, $site_url) {
        return $this->get_request($this->_base_route.'apikey.json?siteurl='.$site_url,
            array('authdetails' => array('username' => $username, 'password' => $password))
        );
    }

    /**
     * Gets an array of clients
     * @access public
     * @return OP_CS_REST_Wrapper_Result A successful response will be an object of the form
     * array(
     *     {
     *         'ClientID' => The clients API ID,
     *         'Name' => The clients name
     *     }
     * )
     */
    function get_clients() {
        return $this->get_request($this->_base_route.'clients.json');
    }

    function get_lists() {
        return $this->get_request($this->_base_route.'lists.json');   
    }

    /**
     * Gets your billing details.
     * @access public
     * @return OP_CS_REST_Wrapper_Result A successful response will be an object of the form
     * {
     *     'Credits' => The number of credits belonging to the account
     * }
     */
    function get_billing_details() {
        return $this->get_request($this->_base_route.'billingdetails.json');
    }

    /**
     * Gets an array of administrators
     * @access public
     * @return OP_CS_REST_Wrapper_Result A successful response will be an object of the form
     * array(
     *     {
     *         'EmailAddress' => The administrators email address
     *         'Name' => The administrators name
     *         'Status' => The administrators status
     *     }
     * )
     */
    function get_administrators() {
    	return $this->get_request($this->_base_route.'admins.json');
    }
    
    /**
     * Retrieves the email address of the primary contact for this account
     * @return OP_CS_REST_Wrapper_Result a successful response will be an array in the form:
     * 		array('EmailAddress'=> email address of primary contact)
     */
    function get_primary_contact() {
    	return $this->get_request($this->_base_route.'primarycontact.json');
    }

    /**
     * Assigns the primary contact for this account to the administrator with the specified email address
     * @param $emailAddress string The email address of the administrator designated to be the primary contact
     * @return OP_CS_REST_Wrapper_Result a successful response will be an array in the form:
     * 		array('EmailAddress'=> email address of primary contact)
     */
    function set_primary_contact($emailAddress) {
    	return $this->put_request($this->_base_route.'primarycontact.json?email=' . urlencode($emailAddress), '');
    }

    /**
     * Get a URL which initiates a new external session for the user with the given email.
     * Full details: http://www.campaignmonitor.com/api/account/#single_sign_on
     *
     * @param $session_options array Options for initiating the external login session.
     *        This should be an array of the form:
     *        array(
     *          'Email' => 'The email address of the Campaign Monitor user for whom the login session should be created',
     *          'Chrome' => 'Which 'chrome' to display - Must be either "all", "tabs", or "none"',
     *          'Url' => 'The URL to display once logged in. e.g. "/subscribers/"',
     *          'IntegratorID' => 'The Integrator ID. You need to contact Campaign Monitor support to get an Integrator ID.',
     *          'ClientID' => 'The Client ID of the client which should be active once logged in to the Campaign Monitor account.' )
     *
     * @return OP_CS_REST_Wrapper_Result A successful response will be an array of the form:
     * 		array('SessionUrl'=> 'https://external1.createsend.com/cd/create/ABCDEF12/DEADBEEF?url=FEEDDAD1')
     */
    function external_session_url($session_options) {
        return $this->put_request($this->_base_route.'externalsession.json', $session_options);
    }
}
