<?php


/**
 * PostmarkClient provides the main functionality used to send an analyze email on a "per-Server"
 * basis. If you'd like to manage "Account-wide" configuration, see the PostmarkAdminClient.
 */
class Thrive_Dash_Api_Postmark extends Thrive_Dash_Api_Postmark_ClientBase {

	private $server_token = null;

	/**
	 * Create a new PostmarkClient.
	 *
	 * @param string $server_token The token associated with "Server" you'd like to use to send/receive email from.
	 * @param integer $timeout The timeout, in seconds to wait for an API call to complete before throwing an Exception.
	 */
	function __construct( $serverToken, $timeout = 30 ) {
		parent::__construct( $serverToken, 'X-Postmark-Server-Token', $timeout );
	}

	/**
	 * Send an email.
	 *
	 * @param  string $from : The sender of the email. (Your account must have an associated Sender Signature for the address used.)
	 * @param  string $to The recipient of the email.
	 * @param  string $subject The subject of the email.
	 * @param  string $htmlBody The HTML content of the message, optional if Text Body is specified.
	 * @param  string $textBody The text content of the message, optional if HTML Body is specified.
	 * @param  string $tag A tag associated with this message, useful for classifying sent messages.
	 * @param  boolean $trackOpens True if you want Postmark to track opens of HTML emails.
	 * @param  string $replyTo Reply to email address.
	 * @param  string $cc Carbon Copy recipients, comma-separated
	 * @param  string $bcc Blind Carbon Copy recipients, comma-separated.
	 * @param  array $headers Headers to be included with the sent email message.
	 * @param  array $attachments An array of PostmarkAttachment objects.
	 *
	 * @return DyanamicResponseModel
	 */
	function sendEmail(
		$from, $to, $subject, $htmlBody = null, $textBody = null,
		$tag = null, $trackOpens = true, $replyTo = null, $cc = null, $bcc = null,
		$headers = null, $attachments = null
	) {

		$body                = array();
		$body['From']        = $from;
		$body['To']          = $to;
		$body['Cc']          = $cc;
		$body['Bcc']         = $bcc;
		$body['Subject']     = $subject;
		$body['HtmlBody']    = $htmlBody;
		$body['TextBody']    = $textBody;
		$body['Tag']         = $tag;
		$body['ReplyTo']     = $replyTo;
		$body['Headers']     = $this->fixHeaders( $headers );
		$body['TrackOpens']  = $trackOpens;
		$body['Attachments'] = $attachments;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'POST', '/email', $body ) );
	}

	/**
	 * Send an email using a template.
	 *
	 * @param  string $from : The sender of the email. (Your account must have an associated Sender Signature for the address used.)
	 * @param  string $to The recipient of the email.
	 * @param  integer $templateId The ID of the template to use to generate the content of this message.
	 * @param  object $templateModel The values to combine with the Templated content.
	 * @param  boolean $inlineCss If the template contains an HTMLBody, CSS is automatically inlined, you may opt-out of this by passing 'false' for this parameter.
	 * @param  string $tag A tag associated with this message, useful for classifying sent messages.
	 * @param  boolean $trackOpens True if you want Postmark to track opens of HTML emails.
	 * @param  string $replyTo Reply to email address.
	 * @param  string $cc Carbon Copy recipients, comma-separated
	 * @param  string $bcc Blind Carbon Copy recipients, comma-separated.
	 * @param  array $headers Headers to be included with the sent email message.
	 * @param  array $attachments An array of PostmarkAttachment objects.
	 *
	 * @return DyanamicResponseModel
	 */
	function sendEmailWithTemplate(
		$from, $to, $templateId, $templateModel, $inlineCss = true,
		$tag = null, $trackOpens = true, $replyTo = null,
		$cc = null, $bcc = null,
		$headers = null, $attachments = null
	) {

		$body                  = array();
		$body['From']          = $from;
		$body['To']            = $to;
		$body['Cc']            = $cc;
		$body['Bcc']           = $bcc;
		$body['Tag']           = $tag;
		$body['ReplyTo']       = $replyTo;
		$body['Headers']       = $this->fixHeaders( $headers );
		$body['TrackOpens']    = $trackOpens;
		$body['Attachments']   = $attachments;
		$body['TemplateModel'] = $templateModel;
		$body['TemplateId']    = $templateId;
		$body['InlineCss']     = $inlineCss;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'POST', '/email/withTemplate', $body ) );
	}

	/**
	 * The Postmark API wants an Array of Key-Value pairs, not a dictionary object,
	 * therefore, we need to wrap the elements in an array.
	 */
	private function fixHeaders( $headers ) {
		$retval = null;
		if ( $headers != null ) {
			$retval = array();
			$index  = 0;
			foreach ( $headers as $key => $value ) {
				$retval[ $index ] = array( 'Name' => $key, 'Value' => $value );
				$index ++;
			}
		}

		return $retval;
	}

	/**
	 * Send multiple emails as a batch
	 *
	 * Each email is an associative array of values, but note that the 'Attachments'
	 * key must be an array of 'PostmarkAttachment' objects if you intend to send
	 * attachments with an email.
	 *
	 * @param array $emailBatch An array of emails to be sent in one batch.
	 *
	 * @return DyanamicResponseModel
	 */
	function sendEmailBatch( $emailBatch = array() ) {

		$final = array();

		foreach ( $emailBatch as $key => $email ) {
			foreach ( $email as $emailIdx => $emailValue ) {
				if ( strtolower( $emailIdx ) == 'headers' ) {
					$email[ $emailIdx ] = $this->fixHeaders( $emailValue );
				}
			}
			array_push( $final, $email );
		}

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'POST', '/email/batch', $final ) );
	}

	/**
	 * Get an overview of the delivery statistics for all email that has been sent through this Server.
	 *
	 * @return DyanamicResponseModel
	 */
	function getDeliveryStatistics() {
		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', '/deliverystats' ) );
	}

	/**
	 * Get a batch of bounces to be processed.
	 *
	 * @param  integer $count Number of bounces to retrieve
	 * @param  integer $offset How many bounces to skip (when paging through bounces.)
	 * @param  string $type The bounce type. (see http://developer.postmarkapp.com/developer-api-bounce.html#bounce-types)
	 * @param  bool $inactive Specifies if the bounce caused Postmark to deactivate this email.
	 * @param  string $emailFilter Filter by email address
	 * @param  string $tag Filter by tag
	 * @param  string $messageID Filter by MessageID
	 * :return DynamicResponseModel
	 */
	function getBounces(
		$count = 100, $offset = 0, $type = null,
		$inactive = null, $emailFilter = null, $tag = null, $messageID = null
	) {

		$query                = array();
		$query['type']        = $type;
		$query['inactive']    = $inactive;
		$query['emailFilter'] = $emailFilter;
		$query['tag']         = $tag;
		$query['messageID']   = $messageID;
		$query['count']       = $count;
		$query['offset']      = $offset;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', '/bounces', $query ) );
	}

	/**
	 * Locate information on a specific email bounce.
	 *
	 * @param  integer $id The ID of the bounce to get.
	 *
	 * @return DyanamicResponseModel
	 */
	function getBounce( $id ) {
		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', "/bounces/$id" ) );
	}

	/**
	 * Get a "dump" for a specific bounce.
	 *
	 * @param  integer $id The ID of the bounce for which we want a dump.
	 *
	 * @return string
	 */
	function getBounceDump( $id ) {
		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', "/bounces/$id/dump" ) );
	}

	/**
	 * Cause the email address associated with a Bounce to be reactivated.
	 *
	 * @param  integer $id The bounce which has a deactivated email address.
	 *
	 * @return DyanamicResponseModel
	 */
	function activateBounce( $id ) {
		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'PUT', "/bounces/$id/activate" ) );
	}

	/**
	 * Get the list of tags associated with messages that have bounced.
	 *
	 * This produces an array of strings. This one of the only client API calls that does not produce a DynamicResponseModel.
	 *
	 * @return array
	 */
	function getBounceTags() {
		return $this->processRestRequest( 'GET', '/bounces/tags' );
	}

	/**
	 * Get the settings for the server associated with this PostmarkClient instance
	 * (defined by the $server_token you passed when instantiating this client)
	 *
	 * @return DyanamicResponseModel
	 */
	function getServer() {
		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', '/server' ) );
	}

	/**
	 * Modify the associated Server. Any parameters passed with NULL will be
	 * ignored (their existing values will not be modified).
	 *
	 * @param  string $name Set the name of the server.
	 * @param  string $color Set the color for the server in the Postmark WebUI (must be: 'purple', 'blue', 'turqoise', 'green', 'red', 'yellow', or 'grey')
	 * @param  bool $rawEmailEnabled Enable raw email to be sent with inbound.
	 * @param  bool $smtpApiActivated Specifies whether or not SMTP is enabled on this server.
	 * @param  string $inboundHookUrl URL to POST to everytime an inbound event occurs.
	 * @param  string $bounceHookUrl URL to POST to everytime a bounce event occurs.
	 * @param  string $openHookUrl URL to POST to everytime an open event occurs.
	 * @param  bool $postFirstOpenOnly If set to true, only the first open by a particular recipient will initiate the open webhook. Any subsequent opens of the same email by the same recipient will not initiate the webhook.
	 * @param  bool $trackOpens Indicates if all emails being sent through this server have open tracking enabled.
	 * @param  string $inboundDomain Inbound domain for MX setup.
	 * @param  integer $inboundSpamThreshold The maximum spam score for an inbound message before it's blocked (range from 0-30).
	 *
	 * @return DyanamicResponseModel
	 */
	function editServer(
		$name = null, $color = null, $rawEmailEnabled = null,
		$smtpApiActivated = null, $inboundHookUrl = null, $bounceHookUrl = null,
		$openHookUrl = null, $postFirstOpenOnly = null, $trackOpens = null,
		$inboundDomain = null, $inboundSpamThreshold = null
	) {

		$body                         = array();
		$body["Name"]                 = $name;
		$body["Color"]                = $color;
		$body["RawEmailEnabled"]      = $rawEmailEnabled;
		$body["SmtpApiActivated"]     = $smtpApiActivated;
		$body["InboundHookUrl"]       = $inboundHookUrl;
		$body["BounceHookUrl"]        = $bounceHookUrl;
		$body["OpenHookUrl"]          = $openHookUrl;
		$body["PostFirstOpenOnly"]    = $postFirstOpenOnly;
		$body["TrackOpens"]           = $trackOpens;
		$body["InboundDomain"]        = $inboundDomain;
		$body["InboundSpamThreshold"] = $inboundSpamThreshold;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'PUT', '/server', $body ) );
	}

	/**
	 * Search messages that have been sent using this Server.
	 *
	 * @param  integer $count How many messages to retrieve at once (defaults to 100)
	 * @param  integer $offset How many messages to skip when 'paging' through the massages (defaults to 0)
	 * @param  string $recipient Filter by recipient.
	 * @param  string $fromEmail Filter by sender email address.
	 * @param  string $tag Filter by tag.
	 * @param  string $subject Filter by subject.
	 * @param  string $status The current status for the outbound messages to return defaults to 'sent'
	 * @param  string $fromdate Filter to messages on or after YYYY-MM-DD
	 * @param  string $todate Filter to messages on or before YYYY-MM-DD
	 *
	 * @return DyanamicResponseModel
	 */
	function getOutboundMessages(
		$count = 100, $offset = 0, $recipient = null,
		$fromEmail = null, $tag = null, $subject = null, $status = null,
		$fromdate = null, $todate = null
	) {

		$query              = array();
		$query["recipient"] = $recipient;
		$query["fromemail"] = $fromEmail;
		$query["tag"]       = $tag;
		$query["subject"]   = $subject;
		$query["count"]     = $count;
		$query["offset"]    = $offset;
		$query["status"]    = $status;
		$query["fromdate"]  = $fromdate;
		$query["todate"]    = $todate;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', '/messages/outbound', $query ) );
	}

	/**
	 * Get information related to a specific sent message.
	 *
	 * @param integer $id The ID of the Message for which we want details.
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function getOutboundMessageDetails( $id ) {
		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', "/messages/outbound/$id/details" ) );
	}

	/**
	 * Get the raw content for a message that was sent.
	 * This response
	 *
	 * @param  integer $id The ID of the message for which we want a dump.
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function getOutboundMessageDump( $id ) {
		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', "/messages/outbound/$id/dump" ) );
	}

	/**
	 * Get messages sent to the inbound email address associated with this Server.
	 *
	 * @param  integer $count The number of inbounce messages to retrieve in the request (defaults to 100)
	 * @param  integer $offset The number of messages to 'skip' when 'paging' through messages (defaults to 0)
	 * @param  string $recipient Filter by the message recipient
	 * @param  string $fromEmail Filter by the message sender
	 * @param  string $tag Filter by the message tag
	 * @param  string $subject Filter by the message subject
	 * @param  string $mailboxHash Filter by the mailboxHash
	 * @param  string $status Filter by status ('blocked' or 'processed')
	 * @param  string $fromdate Filter to messages on or after YYYY-MM-DD
	 * @param  string $todate Filter to messages on or before YYYY-MM-DD
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function getInboundMessages(
		$count = 100, $offset = 0, $recipient = null, $fromEmail = null,
		$tag = null, $subject = null, $mailboxHash = null, $status = null, $fromdate = null,
		$todate = null
	) {

		$query                = array();
		$query['recipient']   = $recipient;
		$query['fromemail']   = $fromEmail;
		$query['tag']         = $tag;
		$query['subject']     = $subject;
		$query['mailboxhash'] = $mailboxHash;
		$query['count']       = $count;
		$query['status']      = $status;
		$query['offset']      = $offset;
		$query['fromdate']    = $fromdate;
		$query['todate']      = $todate;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', '/messages/inbound', $query ) );
	}

	/**
	 * Get details for a specific inbound message.
	 *
	 * @param integer $id The ID of the message for which we went to get details.
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function getInboundMessageDetails( $id ) {
		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', "/messages/inbound/$id/details" ) );
	}

	/**
	 * Allow an inbound message to be processed, even though the filtering rules would normally
	 * prevent it from being processed.
	 *
	 * @param integer $id The ID for a message that we wish to unblock.
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function bypassInboundMessageRules( $id ) {
		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'PUT', "/messages/inbound/$id/bypass" ) );
	}

	/**
	 * Request that Postmark retry POSTing the specified message to the Server's Inbound Hook.
	 *
	 * @param integer $id The ID for a message that we wish retry the inbound hook for.
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function retryInboundMessageHook( $id ) {
		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'PUT', "/messages/inbound/$id/retry" ) );
	}

	/**
	 * Get statistics for tracked messages, optionally filtering by various open event properties.
	 *
	 * @param  integer $count The number of open statistics to retrieve in this request.
	 * @param  integer $offset The number of statistics to 'skip' when paging through statistics.
	 * @param  string $recipient Filter by recipient.
	 * @param  string $tag Filter by tag.
	 * @param  string $clientName Filter by Email Client name.
	 * @param  string $clientCompany Filter by Email Client Company's name.
	 * @param  string $clientFamily Filter by Email Client's Family name.
	 * @param  string $osName Filter by Email Client's Operating System Name.
	 * @param  string $osFamily Filter by Email Client's Operating System's Family.
	 * @param  string $osCompany Filter by Email Client's Operating System's Company.
	 * @param  string $platform Filter by Email Client's Platform Name.
	 * @param  string $country Filter by Country.
	 * @param  string $region Filter by Region.
	 * @param  string $city Filter by City.
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function getOpenStatistics(
		$count = 100, $offset = 0, $recipient = null,
		$tag = null, $clientName = null, $clientCompany = null, $clientFamily = null,
		$osName = null, $osFamily = null, $osCompany = null, $platform = null,
		$country = null, $region = null, $city = null
	) {

		$query                   = array();
		$query['count']          = $count;
		$query['offset']         = $offset;
		$query['recipient']      = $recipient;
		$query['tag']            = $tag;
		$query['client_name']    = $clientName;
		$query['client_company'] = $clientCompany;
		$query['client_family']  = $clientFamily;
		$query['os_name']        = $osName;
		$query['os_family']      = $osFamily;
		$query['os_company']     = $osCompany;
		$query['platform']       = $platform;
		$query['country']        = $country;
		$query['region']         = $region;
		$query['city']           = $city;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', '/messages/outbound/opens', $query ) );
	}

	/**
	 * Get information about individual opens for a sent message.
	 *
	 * @param  integer $id The ID for the message that we want statistics for.
	 * @param  integer $count How many statistics should we retrieve?
	 * @param  integer $offset How many should we 'skip' when 'paging' through statistics.
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function getOpenStatisticsForMessage( $id, $count = 100, $offset = 0 ) {
		$query = array();

		$query['count']  = $count;
		$query['offset'] = $offset;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', "/messages/outbound/opens/$id", $query ) );
	}

	/**
	 * Get an overview of the messages sent using this Server,
	 * optionally filtering on message tag, and a to and from date.
	 *
	 * @param  string $tag Filter by tag.
	 * @param  string $fromdate must be of the format 'YYYY-MM-DD'
	 * @param  string $todate must be of the format 'YYYY-MM-DD'
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function getOutboundOverviewStatistics( $tag = null, $fromdate = null, $todate = null ) {
		$query = array();

		$query['tag']      = $tag;
		$query['fromdate'] = $fromdate;
		$query['todate']   = $todate;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', '/stats/outbound', $query ) );
	}

	/**
	 * Get send statistics for the messages sent using this Server,
	 * optionally filtering on message tag, and a to and from date.
	 *
	 * @param  string $tag Filter by tag.
	 * @param  string $fromdate must be of the format 'YYYY-MM-DD'
	 * @param  string $todate must be of the format 'YYYY-MM-DD'
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function getOutboundSendStatistics( $tag = null, $fromdate = null, $todate = null ) {
		$query = array();

		$query['tag']      = $tag;
		$query['fromdate'] = $fromdate;
		$query['todate']   = $todate;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', '/stats/outbound/sends', $query ) );
	}

	/**
	 * Get bounce statistics for the messages sent using this Server,
	 * optionally filtering on message tag, and a to and from date.
	 *
	 * @param  string $tag Filter by tag.
	 * @param  string $fromdate must be of the format 'YYYY-MM-DD'
	 * @param  string $todate must be of the format 'YYYY-MM-DD'
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function getOutboundBounceStatistics( $tag = null, $fromdate = null, $todate = null ) {
		$query = array();

		$query['tag']      = $tag;
		$query['fromdate'] = $fromdate;
		$query['todate']   = $todate;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', '/stats/outbound/bounces', $query ) );
	}

	/**
	 * Get SPAM complaint statistics for the messages sent using this Server,
	 * optionally filtering on message tag, and a to and from date.
	 *
	 * @param  string $tag Filter by tag.
	 * @param  string $fromdate must be of the format 'YYYY-MM-DD'
	 * @param  string $todate must be of the format 'YYYY-MM-DD'
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function getOutboundSpamComplaintStatistics( $tag = null, $fromdate = null, $todate = null ) {
		$query = array();

		$query['tag']      = $tag;
		$query['fromdate'] = $fromdate;
		$query['todate']   = $todate;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', '/stats/outbound/spam', $query ) );
	}

	/**
	 * Get bounce statistics for the messages sent using this Server,
	 * optionally filtering on message tag, and a to and from date.
	 *
	 * @param  string $tag Filter by tag.
	 * @param  string $fromdate must be of the format 'YYYY-MM-DD'
	 * @param  string $todate must be of the format 'YYYY-MM-DD'
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function getOutboundTrackedStatistics( $tag = null, $fromdate = null, $todate = null ) {
		$query = array();

		$query['tag']      = $tag;
		$query['fromdate'] = $fromdate;
		$query['todate']   = $todate;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', '/stats/outbound/tracked', $query ) );
	}

	/**
	 * Get open statistics for the messages sent using this Server,
	 * optionally filtering on message tag, and a to and from date.
	 *
	 * @param  string $tag Filter by tag.
	 * @param  string $fromdate must be of the format 'YYYY-MM-DD'
	 * @param  string $todate must be of the format 'YYYY-MM-DD'
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function getOutboundOpenStatistics( $tag = null, $fromdate = null, $todate = null ) {
		$query = array();

		$query['tag']      = $tag;
		$query['fromdate'] = $fromdate;
		$query['todate']   = $todate;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', '/stats/outbound/opens', $query ) );
	}

	/**
	 * Get platform statistics for the messages sent using this Server,
	 * optionally filtering on message tag, and a to and from date.
	 *
	 * @param  string $tag Filter by tag.
	 * @param  string $fromdate must be of the format 'YYYY-MM-DD'
	 * @param  string $todate must be of the format 'YYYY-MM-DD'
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function getOutboundPlatformStatistics( $tag = null, $fromdate = null, $todate = null ) {
		$query = array();

		$query['tag']      = $tag;
		$query['fromdate'] = $fromdate;
		$query['todate']   = $todate;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', '/stats/outbound/opens/platforms', $query ) );
	}

	/**
	 * Get email client statistics for the messages sent using this Server,
	 * optionally filtering on message tag, and a to and from date.
	 *
	 * @param  string $tag Filter by tag.
	 * @param  string $fromdate must be of the format 'YYYY-MM-DD'
	 * @param  string $todate must be of the format 'YYYY-MM-DD'
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function getOutboundEmailClientStatistics( $tag = null, $fromdate = null, $todate = null ) {
		$query = array();

		$query['tag']      = $tag;
		$query['fromdate'] = $fromdate;
		$query['todate']   = $todate;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', '/stats/outbound/opens/emailclients', $query ) );
	}

	/**
	 * Get reading times for the messages sent using this Server,
	 * optionally filtering on message tag, and a to and from date.
	 *
	 * @param  string $tag Filter by tag.
	 * @param  string $fromdate must be of the format 'YYYY-MM-DD'
	 * @param  string $todate must be of the format 'YYYY-MM-DD'
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function getOutboundReadTimeStatistics( $tag = null, $fromdate = null, $todate = null ) {
		$query = array();

		$query['tag']      = $tag;
		$query['fromdate'] = $fromdate;
		$query['todate']   = $todate;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', '/stats/outbound/opens/readtimes', $query ) );
	}

	/**
	 * Create a Tag Trigger.
	 *
	 * @param  string $matchName Name of the tag that will activate this trigger.
	 * @param  boolean $trackOpens Indicates if this trigger activates open tracking.
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function createTagTrigger( $matchName, $trackOpens = true ) {
		$body               = array();
		$body["MatchName"]  = $matchName;
		$body["TrackOpens"] = $trackOpens;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'POST', '/triggers/tags', $body ) );
	}

	/**
	 * Delete a Tag Trigger with the given ID.
	 *
	 * @param integer $id The ID of the Tag Trigger we wish to delete.
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function deleteTagTrigger( $id ) {
		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'DELETE', "/triggers/tags/$id" ) );
	}

	/**
	 * Locate Tag Triggers matching the filter criteria.
	 *
	 * @param  integer $count The number of triggers to return with this request.
	 * @param  integer $offset The number of triggers to 'skip' when 'paging' through tag triggers.
	 * @param  string $matchName
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function searchTagTriggers( $count = 100, $offset = 0, $matchName = null ) {
		$query = array();

		$query["count"]      = $count;
		$query["offset"]     = $offset;
		$query["match_name"] = $matchName;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', '/triggers/tags', $query ) );
	}

	/**
	 * Edit an existing Tag Trigger
	 *
	 * @param  integer $id The ID of the Tag Trigger we wish to modify.
	 * @param  string $matchName Name of the tag that will activate this trigger.
	 * @param  boolean $trackOpens Indicates if this trigger activates open tracking.
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function editTagTrigger( $id, $matchName, $trackOpens = true ) {
		$body               = array();
		$body["MatchName"]  = $matchName;
		$body["TrackOpens"] = $trackOpens;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'PUT', "/triggers/tags/$id", $body ) );
	}

	/**
	 * Retrieve information related to the associated Tag Trigger
	 *
	 * @param integer $id The ID of the Tag Trigger we wish to retrieve.
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function getTagTrigger( $id ) {
		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', "/triggers/tags/$id" ) );
	}

	/**
	 * Create an Inbound Rule to block messages from a single email address, or an entire domain.
	 *
	 * @param  string $rule The email address (or domain) that will be blocked.
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function createInboundRuleTrigger( $rule ) {
		$body         = array();
		$body["Rule"] = $rule;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'POST', '/triggers/inboundrules', $body ) );
	}

	/**
	 * Get a list of all existing Inbound Rule Triggers.
	 *
	 * @param integer $count The number of rule triggers to return with this request.
	 * @param integer $offset The number of triggers to 'skip' when 'paging' through rule triggers.
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function listInboundRuleTriggers( $count = 100, $offset = 0 ) {
		$query = array();

		$query["count"]  = $count;
		$query["offset"] = $offset;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', '/triggers/inboundrules', $query ) );
	}

	/**
	 * Delete an Inbound Rule Trigger.
	 *
	 * @param integer $id The ID of the rule trigger we wish to delete.
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function deleteInboundRuleTrigger( $id ) {
		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'DELETE', "/triggers/inboundrules/$id" ) );
	}

	/**
	 * Delete a template.
	 *
	 * @param integer $id The ID of the template to delete.
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function deleteTemplate( $id ) {
		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'DELETE', "/templates/$id" ) );
	}

	/**
	 * Create a template
	 *
	 * @param string $name The friendly name for this template.
	 * @param string $subject The template to be used for the 'subject' of emails sent using this template.
	 * @param string $htmlBody The template to be used for the 'htmlBody' of emails sent using this template, optional if 'textBody' is not NULL.
	 * @param string $textBody The template to be used for the 'textBody' of emails sent using this template, optional if 'htmlBody' is not NULL.
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function createTemplate( $name, $subject, $htmlBody, $textBody ) {
		$template             = array();
		$template["name"]     = $name;
		$template["subject"]  = $subject;
		$template["htmlBody"] = $htmlBody;
		$template["textBody"] = $textBody;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'POST', "/templates", $template ) );
	}

	/**
	 * Edit a template
	 *
	 * @param integer $id The ID of the template you wish to update.
	 * @param string $name The friendly name for this template.
	 * @param string $subject The template to be used for the 'subject' of emails sent using this template.
	 * @param string $htmlBody The template to be used for the 'htmlBody' of emails sent using this template.
	 * @param string $textBody The template to be used for the 'textBody' of emails sent using this template.
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function editTemplate( $id, $name = null, $subject = null, $htmlBody = null, $textBody = null ) {
		$template             = array();
		$template["name"]     = $name;
		$template["subject"]  = $subject;
		$template["htmlBody"] = $htmlBody;
		$template["textBody"] = $textBody;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'PUT', "/templates/$id", $template ) );
	}

	/**
	 * Get the current information for a specific template.
	 *
	 * @param integer $id the Id for the template info you wish to retrieve.
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function getTemplate( $id ) {
		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', "/templates/$id" ) );
	}

	/**
	 * Get all templates associated with the Server.
	 *
	 * @param integer $count The total number of templates to get at once (default is 100)
	 * @param integer $offset The number of templates to "Skip" before returning results.
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function listTemplates( $count = 100, $offset = 0 ) {
		$query = array();

		$query["count"]  = $count;
		$query["offset"] = $offset;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'GET', "/templates", $query ) );
	}

	/**
	 * Confirm that your template content can be parsed/rendered, get a test rendering of your template, and a suggested model to use with your templates.
	 *
	 * @param string $subject The Subject template you wish to test.
	 * @param string $htmlBody The HTML template you wish to test
	 * @param string $textBody The number of templates to "Skip" before returning results.
	 * @param object $testingRenderModel The model to be used when doing test renders of the templates that successfully parse in this request.
	 * @param bool $inlineCssForHtmlTestRender If htmlBody is specified, the test render will automatically do CSS Inlining for the HTML content. You may opt-out of this behavior by passing 'false' for this parameter.
	 *
	 * @return Thrive_Dash_Api_Postmark_DynamicResponseModel
	 */
	function validateTemplate( $subject = null, $htmlBody = null, $textBody = null, $testRenderModel = null, $inlineCssForHtmlTestRender = true ) {
		$query = array();

		$query["subject"]                    = $subject;
		$query["htmlBody"]                   = $htmlBody;
		$query["textBody"]                   = $textBody;
		$query["testRenderModel"]            = $testRenderModel;
		$query["inlineCssForHtmlTestRender"] = $inlineCssForHtmlTestRender;

		return new Thrive_Dash_Api_Postmark_DynamicResponseModel( $this->processRestRequest( 'POST', "/templates/validate", $query ) );
	}
}

?>
