| Server IP : 67.43.7.42 / Your IP : 216.73.216.61 Web Server : Apache System : Linux host.isabellascookies.com 2.6.32-754.35.1.el6.x86_64 #1 SMP Sat Nov 7 12:42:14 UTC 2020 x86_64 User : isabella ( 503) PHP Version : 5.5.38 Disable Function : exec,passthru,shell_exec,system MySQL : ON | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /home/isabella/public_html/constant/docs/ |
Upload File : |
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Ctct/ConstantContact.php | Appconnect PHP SDK</title>
<script type="text/javascript" src="resources/combined.js?554516056"></script>
<script type="text/javascript" src="elementlist.js?1423846706"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-Ctct.html">Ctct<span></span></a>
<ul>
<li><a href="namespace-Ctct.Auth.html">Auth</a>
</li>
<li><a href="namespace-Ctct.Components.html">Components<span></span></a>
<ul>
<li><a href="namespace-Ctct.Components.Account.html">Account</a>
</li>
<li><a href="namespace-Ctct.Components.Activities.html">Activities</a>
</li>
<li><a href="namespace-Ctct.Components.Contacts.html">Contacts</a>
</li>
<li><a href="namespace-Ctct.Components.EmailMarketing.html">EmailMarketing</a>
</li>
<li><a href="namespace-Ctct.Components.Tracking.html">Tracking</a>
</li>
</ul></li>
<li><a href="namespace-Ctct.Exceptions.html">Exceptions</a>
</li>
<li><a href="namespace-Ctct.Services.html">Services</a>
</li>
</ul></li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li class="active"><a href="class-Ctct.ConstantContact.html">ConstantContact</a></li>
<li><a href="class-Ctct.SplClassLoader.html">SplClassLoader</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-Ctct.html" title="Summary of Ctct"><span>Namespace</span></a>
</li>
<li>
<a href="class-Ctct.ConstantContact.html" title="Summary of Ctct\ConstantContact"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a><span class="php-keyword1">namespace</span> Ctct;
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a>
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">use</span> Ctct\Services\BaseService;
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-keyword1">use</span> Ctct\Services\AccountService;
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-keyword1">use</span> Ctct\Services\ContactService;
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-keyword1">use</span> Ctct\Services\ListService;
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-keyword1">use</span> Ctct\Services\EmailMarketingService;
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">use</span> Ctct\Services\CampaignScheduleService;
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-keyword1">use</span> Ctct\Services\CampaignTrackingService;
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-keyword1">use</span> Ctct\Services\ContactTrackingService;
</span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-keyword1">use</span> Ctct\Services\ActivityService;
</span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-keyword1">use</span> Ctct\Components\Account\VerifiedEmailAddress;
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">use</span> Ctct\Components\Contacts\Contact;
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-keyword1">use</span> Ctct\Components\Contacts\ContactList;
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-keyword1">use</span> Ctct\Components\EmailMarketing\Campaign;
</span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-keyword1">use</span> Ctct\Components\EmailMarketing\Schedule;
</span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-keyword1">use</span> Ctct\Components\EmailMarketing\TestSend;
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">use</span> Ctct\Components\Tracking\TrackingSummary;
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-keyword1">use</span> Ctct\Components\Tracking\TrackingActivity;
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-keyword1">use</span> Ctct\Components\Activities\AddContacts;
</span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-keyword1">use</span> Ctct\Components\Activities\ExportContacts;
</span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-keyword1">use</span> Ctct\Exceptions\CtctException;
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">use</span> Ctct\Exceptions\IllegalArgumentException;
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a><span class="php-keyword1">use</span> Ctct\Util\Config;
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-keyword1">use</span> Ctct\Components\ResultSet;
</span><span id="27" class="l"><a class="l" href="#27"> 27: </a>
</span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment">/**
</span></span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-comment"> * Exposes all implemented Constant Contact API functionality
</span></span><span id="30" class="l"><a class="l" href="#30"> 30: </a><span class="php-comment"> *
</span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> * @package Ctct
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * @version 1.1.0
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> * @author Constant Contact
</span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment"> */</span>
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a><span class="php-keyword1">class</span> <a id="ConstantContact" href="#ConstantContact">ConstantContact</a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a>{
</span><span id="37" class="l"><a class="l" href="#37"> 37: </a> <span class="php-comment">/**
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> * Constant Contact API Key
</span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> * @var string
</span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment"> */</span>
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$apiKey" href="#$apiKey">$apiKey</a></span>;
</span><span id="42" class="l"><a class="l" href="#42"> 42: </a>
</span><span id="43" class="l"><a class="l" href="#43"> 43: </a> <span class="php-comment">/**
</span></span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-comment"> * ContactService for handling interaction with contact management
</span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment"> * @var ContactService
</span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment"> */</span>
</span><span id="47" class="l"><a class="l" href="#47"> 47: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$contactService" href="#$contactService">$contactService</a></span>;
</span><span id="48" class="l"><a class="l" href="#48"> 48: </a>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a> <span class="php-comment">/**
</span></span><span id="50" class="l"><a class="l" href="#50"> 50: </a><span class="php-comment"> * EmailMarketingService for handling interaction with email marketing
</span></span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment"> * @var CampaignService
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> */</span>
</span><span id="53" class="l"><a class="l" href="#53"> 53: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$emailMarketingService" href="#$emailMarketingService">$emailMarketingService</a></span>;
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a>
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a> <span class="php-comment">/**
</span></span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment"> * ListService for handling interaction with contact list management
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * @var ListService
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$listService" href="#$listService">$listService</a></span>;
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a> <span class="php-comment">/**
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * ActivityService for handling interaction with bulk activities
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> * @var ActivityService
</span></span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-comment"> */</span>
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$activityService" href="#$activityService">$activityService</a></span>;
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a>
</span><span id="67" class="l"><a class="l" href="#67"> 67: </a> <span class="php-comment">/**
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> * CampaignTrackingService for handling interaction with email marketing tracking
</span></span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-comment"> * @var CampaignTrackingService
</span></span><span id="70" class="l"><a class="l" href="#70"> 70: </a><span class="php-comment"> */</span>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$campaignTrackingService" href="#$campaignTrackingService">$campaignTrackingService</a></span>;
</span><span id="72" class="l"><a class="l" href="#72"> 72: </a>
</span><span id="73" class="l"><a class="l" href="#73"> 73: </a> <span class="php-comment">/**
</span></span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-comment"> * ContactTrackingService for handling interaction with contact tracking
</span></span><span id="75" class="l"><a class="l" href="#75"> 75: </a><span class="php-comment"> * @var ContactTrackingService
</span></span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment"> */</span>
</span><span id="77" class="l"><a class="l" href="#77"> 77: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$contactTrackingService" href="#$contactTrackingService">$contactTrackingService</a></span>;
</span><span id="78" class="l"><a class="l" href="#78"> 78: </a>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a> <span class="php-comment">/**
</span></span><span id="80" class="l"><a class="l" href="#80"> 80: </a><span class="php-comment"> * CampaignScheduleService for handling interaction with email marketing campaign scheduling
</span></span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment"> * @var CampaignScheduleService
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> */</span>
</span><span id="83" class="l"><a class="l" href="#83"> 83: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$campaignScheduleService" href="#$campaignScheduleService">$campaignScheduleService</a></span>;
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a>
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a> <span class="php-comment">/**
</span></span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment"> * AccountService for handling interaction with account management
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * @var AccountService
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$accountService" href="#$accountService">$accountService</a></span>;
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a> <span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * Class constructor
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> * Registers the API key with the ConstantContact class that will be used for all API calls.
</span></span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-comment"> * @param string $apiKey - Constant Contact API Key
</span></span><span id="95" class="l"><a class="l" href="#95"> 95: </a><span class="php-comment"> */</span>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>(<span class="php-var">$apiKey</span>)
</span><span id="97" class="l"><a class="l" href="#97"> 97: </a> {
</span><span id="98" class="l"><a class="l" href="#98"> 98: </a> <span class="php-var">$this</span>->apiKey = <span class="php-var">$apiKey</span>;
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a> <span class="php-var">$this</span>->contactService = <span class="php-keyword1">new</span> ContactService(<span class="php-var">$apiKey</span>);
</span><span id="100" class="l"><a class="l" href="#100">100: </a> <span class="php-var">$this</span>->emailMarketingService = <span class="php-keyword1">new</span> EmailMarketingService(<span class="php-var">$apiKey</span>);
</span><span id="101" class="l"><a class="l" href="#101">101: </a> <span class="php-var">$this</span>->activityService = <span class="php-keyword1">new</span> ActivityService(<span class="php-var">$apiKey</span>);
</span><span id="102" class="l"><a class="l" href="#102">102: </a> <span class="php-var">$this</span>->campaignTrackingService = <span class="php-keyword1">new</span> CampaignTrackingService(<span class="php-var">$apiKey</span>);
</span><span id="103" class="l"><a class="l" href="#103">103: </a> <span class="php-var">$this</span>->contactTrackingService = <span class="php-keyword1">new</span> ContactTrackingService(<span class="php-var">$apiKey</span>);
</span><span id="104" class="l"><a class="l" href="#104">104: </a> <span class="php-var">$this</span>->campaignScheduleService = <span class="php-keyword1">new</span> CampaignScheduleService(<span class="php-var">$apiKey</span>);
</span><span id="105" class="l"><a class="l" href="#105">105: </a> <span class="php-var">$this</span>->listService = <span class="php-keyword1">new</span> ListService(<span class="php-var">$apiKey</span>);
</span><span id="106" class="l"><a class="l" href="#106">106: </a> <span class="php-var">$this</span>->accountService = <span class="php-keyword1">new</span> AccountService(<span class="php-var">$apiKey</span>);
</span><span id="107" class="l"><a class="l" href="#107">107: </a> }
</span><span id="108" class="l"><a class="l" href="#108">108: </a>
</span><span id="109" class="l"><a class="l" href="#109">109: </a> <span class="php-comment">/**
</span></span><span id="110" class="l"><a class="l" href="#110">110: </a><span class="php-comment"> * Get a set of campaigns
</span></span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * @param mixed $params - associative array of query parameters and values to append to the request.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> * Allow parameters include:
</span></span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-comment"> * limit - Specifies the number of results displayed per page of output, from 1 - 500, default = 50.
</span></span><span id="115" class="l"><a class="l" href="#115">115: </a><span class="php-comment"> * modified_since - ISO-8601 formatted timestamp.
</span></span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment"> * next - the next link returned from a previous paginated call. May only be used by itself.
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * email - the contact by email address to retrieve information for
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> * @return ResultSet containing a results array of {@link Ctct\Components\Contacts\Contact}
</span></span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-comment"> */</span>
</span><span id="120" class="l"><a class="l" href="#120">120: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getContacts" href="#_getContacts">getContacts</a>(<span class="php-var">$accessToken</span>, <span class="php-keyword1">array</span> <span class="php-var">$params</span> = <span class="php-keyword1">array</span>())
</span><span id="121" class="l"><a class="l" href="#121">121: </a> {
</span><span id="122" class="l"><a class="l" href="#122">122: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->contactService->getContacts(<span class="php-var">$accessToken</span>, <span class="php-var">$params</span>);
</span><span id="123" class="l"><a class="l" href="#123">123: </a> }
</span><span id="124" class="l"><a class="l" href="#124">124: </a>
</span><span id="125" class="l"><a class="l" href="#125">125: </a> <span class="php-comment">/**
</span></span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment"> * Get an individual contact
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * @param string $accessToken - Valid access token
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> * @param int $contactId - Id of the contact to retrieve
</span></span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-comment"> * @return Contact
</span></span><span id="130" class="l"><a class="l" href="#130">130: </a><span class="php-comment"> */</span>
</span><span id="131" class="l"><a class="l" href="#131">131: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getContact" href="#_getContact">getContact</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$contactId</span>)
</span><span id="132" class="l"><a class="l" href="#132">132: </a> {
</span><span id="133" class="l"><a class="l" href="#133">133: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->contactService->getContact(<span class="php-var">$accessToken</span>, <span class="php-var">$contactId</span>);
</span><span id="134" class="l"><a class="l" href="#134">134: </a> }
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a> <span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * Get contacts with a specified email eaddress
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-comment"> * @param string $email - contact email address to search for
</span></span><span id="140" class="l"><a class="l" href="#140">140: </a><span class="php-comment"> * @return array
</span></span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment"> */</span>
</span><span id="142" class="l"><a class="l" href="#142">142: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getContactByEmail" href="#_getContactByEmail">getContactByEmail</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$email</span>)
</span><span id="143" class="l"><a class="l" href="#143">143: </a> {
</span><span id="144" class="l"><a class="l" href="#144">144: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->contactService->getContacts(<span class="php-var">$accessToken</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'email'</span> => <span class="php-var">$email</span>));
</span><span id="145" class="l"><a class="l" href="#145">145: </a> }
</span><span id="146" class="l"><a class="l" href="#146">146: </a>
</span><span id="147" class="l"><a class="l" href="#147">147: </a> <span class="php-comment">/**
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> * Add a new contact to an account
</span></span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-comment"> * @param string $accessToken - Valid access token
</span></span><span id="150" class="l"><a class="l" href="#150">150: </a><span class="php-comment"> * @param Contact $contact - Contact to add
</span></span><span id="151" class="l"><a class="l" href="#151">151: </a><span class="php-comment"> * @param boolean $actionByVisitor - is the action being taken by the visitor
</span></span><span id="152" class="l"><a class="l" href="#152">152: </a><span class="php-comment"> * @return Contact
</span></span><span id="153" class="l"><a class="l" href="#153">153: </a><span class="php-comment"> */</span>
</span><span id="154" class="l"><a class="l" href="#154">154: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_addContact" href="#_addContact">addContact</a>(<span class="php-var">$accessToken</span>, Contact <span class="php-var">$contact</span>, <span class="php-var">$actionByVisitor</span> = <span class="php-keyword1">false</span>)
</span><span id="155" class="l"><a class="l" href="#155">155: </a> {
</span><span id="156" class="l"><a class="l" href="#156">156: </a> <span class="php-var">$params</span> = <span class="php-keyword1">array</span>();
</span><span id="157" class="l"><a class="l" href="#157">157: </a> <span class="php-keyword1">if</span> (<span class="php-var">$actionByVisitor</span> == <span class="php-keyword1">true</span>) {
</span><span id="158" class="l"><a class="l" href="#158">158: </a> <span class="php-var">$params</span>[<span class="php-quote">'action_by'</span>] = <span class="php-quote">"ACTION_BY_VISITOR"</span>;
</span><span id="159" class="l"><a class="l" href="#159">159: </a> }
</span><span id="160" class="l"><a class="l" href="#160">160: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->contactService->addContact(<span class="php-var">$accessToken</span>, <span class="php-var">$contact</span>, <span class="php-var">$params</span>);
</span><span id="161" class="l"><a class="l" href="#161">161: </a> }
</span><span id="162" class="l"><a class="l" href="#162">162: </a>
</span><span id="163" class="l"><a class="l" href="#163">163: </a> <span class="php-comment">/**
</span></span><span id="164" class="l"><a class="l" href="#164">164: </a><span class="php-comment"> * Sets an individual contact to 'REMOVED' status
</span></span><span id="165" class="l"><a class="l" href="#165">165: </a><span class="php-comment"> * @param string $accessToken - Valid access token
</span></span><span id="166" class="l"><a class="l" href="#166">166: </a><span class="php-comment"> * @param mixed $contact - Either a Contact id or the Contact itself
</span></span><span id="167" class="l"><a class="l" href="#167">167: </a><span class="php-comment"> * @throws IllegalArgumentException - if an int or Contact object is not provided
</span></span><span id="168" class="l"><a class="l" href="#168">168: </a><span class="php-comment"> * @return boolean
</span></span><span id="169" class="l"><a class="l" href="#169">169: </a><span class="php-comment"> */</span>
</span><span id="170" class="l"><a class="l" href="#170">170: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_deleteContact" href="#_deleteContact">deleteContact</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$contact</span>)
</span><span id="171" class="l"><a class="l" href="#171">171: </a> {
</span><span id="172" class="l"><a class="l" href="#172">172: </a> <span class="php-var">$contactId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$contact</span>, <span class="php-quote">'Contact'</span>);
</span><span id="173" class="l"><a class="l" href="#173">173: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->contactService->deleteContact(<span class="php-var">$accessToken</span>, <span class="php-var">$contactId</span>);
</span><span id="174" class="l"><a class="l" href="#174">174: </a> }
</span><span id="175" class="l"><a class="l" href="#175">175: </a>
</span><span id="176" class="l"><a class="l" href="#176">176: </a> <span class="php-comment">/**
</span></span><span id="177" class="l"><a class="l" href="#177">177: </a><span class="php-comment"> * Delete a contact from all contact lists
</span></span><span id="178" class="l"><a class="l" href="#178">178: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="179" class="l"><a class="l" href="#179">179: </a><span class="php-comment"> * @param mixed $contact - Contact id or the Contact object itself
</span></span><span id="180" class="l"><a class="l" href="#180">180: </a><span class="php-comment"> * @throws IllegalArgumentException - if an int or Contact object is not provided
</span></span><span id="181" class="l"><a class="l" href="#181">181: </a><span class="php-comment"> * @return boolean
</span></span><span id="182" class="l"><a class="l" href="#182">182: </a><span class="php-comment"> */</span>
</span><span id="183" class="l"><a class="l" href="#183">183: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_deleteContactFromLists" href="#_deleteContactFromLists">deleteContactFromLists</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$contact</span>)
</span><span id="184" class="l"><a class="l" href="#184">184: </a> {
</span><span id="185" class="l"><a class="l" href="#185">185: </a> <span class="php-var">$contactId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$contact</span>, <span class="php-quote">'Contact'</span>);
</span><span id="186" class="l"><a class="l" href="#186">186: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->contactService->deleteContactFromLists(<span class="php-var">$accessToken</span>, <span class="php-var">$contactId</span>);
</span><span id="187" class="l"><a class="l" href="#187">187: </a> }
</span><span id="188" class="l"><a class="l" href="#188">188: </a>
</span><span id="189" class="l"><a class="l" href="#189">189: </a> <span class="php-comment">/**
</span></span><span id="190" class="l"><a class="l" href="#190">190: </a><span class="php-comment"> * Delete a contact from all contact lists
</span></span><span id="191" class="l"><a class="l" href="#191">191: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="192" class="l"><a class="l" href="#192">192: </a><span class="php-comment"> * @param mixed $contact - Contact id or a Contact object
</span></span><span id="193" class="l"><a class="l" href="#193">193: </a><span class="php-comment"> * @param mixed $list - ContactList id or a ContactList object
</span></span><span id="194" class="l"><a class="l" href="#194">194: </a><span class="php-comment"> * @throws IllegalArgumentException - if an int or Contact object is not provided,
</span></span><span id="195" class="l"><a class="l" href="#195">195: </a><span class="php-comment"> * as well as an int or ContactList object
</span></span><span id="196" class="l"><a class="l" href="#196">196: </a><span class="php-comment"> * @return boolean
</span></span><span id="197" class="l"><a class="l" href="#197">197: </a><span class="php-comment"> */</span>
</span><span id="198" class="l"><a class="l" href="#198">198: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_deleteContactFromList" href="#_deleteContactFromList">deleteContactFromList</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$contact</span>, <span class="php-var">$list</span>)
</span><span id="199" class="l"><a class="l" href="#199">199: </a> {
</span><span id="200" class="l"><a class="l" href="#200">200: </a> <span class="php-var">$contactId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$contact</span>, <span class="php-quote">'Contact'</span>);
</span><span id="201" class="l"><a class="l" href="#201">201: </a> <span class="php-var">$listId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$list</span>, <span class="php-quote">'ContactList'</span>);
</span><span id="202" class="l"><a class="l" href="#202">202: </a>
</span><span id="203" class="l"><a class="l" href="#203">203: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->contactService->deleteContactFromList(<span class="php-var">$accessToken</span>, <span class="php-var">$contactId</span>, <span class="php-var">$listId</span>);
</span><span id="204" class="l"><a class="l" href="#204">204: </a> }
</span><span id="205" class="l"><a class="l" href="#205">205: </a>
</span><span id="206" class="l"><a class="l" href="#206">206: </a> <span class="php-comment">/**
</span></span><span id="207" class="l"><a class="l" href="#207">207: </a><span class="php-comment"> * Update an individual contact
</span></span><span id="208" class="l"><a class="l" href="#208">208: </a><span class="php-comment"> * @param string $accessToken - Valid access token
</span></span><span id="209" class="l"><a class="l" href="#209">209: </a><span class="php-comment"> * @param Contact $contact - Contact to update
</span></span><span id="210" class="l"><a class="l" href="#210">210: </a><span class="php-comment"> * @param boolean $actionByVisitor - is the action being taken by the visitor, default is false
</span></span><span id="211" class="l"><a class="l" href="#211">211: </a><span class="php-comment"> * @return Contact
</span></span><span id="212" class="l"><a class="l" href="#212">212: </a><span class="php-comment"> */</span>
</span><span id="213" class="l"><a class="l" href="#213">213: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_updateContact" href="#_updateContact">updateContact</a>(<span class="php-var">$accessToken</span>, Contact <span class="php-var">$contact</span>, <span class="php-var">$actionByVisitor</span> = <span class="php-keyword1">false</span>)
</span><span id="214" class="l"><a class="l" href="#214">214: </a> {
</span><span id="215" class="l"><a class="l" href="#215">215: </a> <span class="php-var">$params</span> = <span class="php-keyword1">array</span>();
</span><span id="216" class="l"><a class="l" href="#216">216: </a> <span class="php-keyword1">if</span> (<span class="php-var">$actionByVisitor</span> == <span class="php-keyword1">true</span>) {
</span><span id="217" class="l"><a class="l" href="#217">217: </a> <span class="php-var">$params</span>[<span class="php-quote">'action_by'</span>] = <span class="php-quote">"ACTION_BY_VISITOR"</span>;
</span><span id="218" class="l"><a class="l" href="#218">218: </a> }
</span><span id="219" class="l"><a class="l" href="#219">219: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->contactService->updateContact(<span class="php-var">$accessToken</span>, <span class="php-var">$contact</span>, <span class="php-var">$params</span>);
</span><span id="220" class="l"><a class="l" href="#220">220: </a> }
</span><span id="221" class="l"><a class="l" href="#221">221: </a>
</span><span id="222" class="l"><a class="l" href="#222">222: </a> <span class="php-comment">/**
</span></span><span id="223" class="l"><a class="l" href="#223">223: </a><span class="php-comment"> * Get lists
</span></span><span id="224" class="l"><a class="l" href="#224">224: </a><span class="php-comment"> * @param string $accessToken - Valid access token
</span></span><span id="225" class="l"><a class="l" href="#225">225: </a><span class="php-comment"> * @param string $date - ISO-8601 date to query by
</span></span><span id="226" class="l"><a class="l" href="#226">226: </a><span class="php-comment"> * @return array
</span></span><span id="227" class="l"><a class="l" href="#227">227: </a><span class="php-comment"> */</span>
</span><span id="228" class="l"><a class="l" href="#228">228: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getLists" href="#_getLists">getLists</a>(<span class="php-var">$accessToken</span>, <span class="php-keyword1">array</span> <span class="php-var">$params</span> = <span class="php-keyword1">array</span>())
</span><span id="229" class="l"><a class="l" href="#229">229: </a> {
</span><span id="230" class="l"><a class="l" href="#230">230: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->listService->getLists(<span class="php-var">$accessToken</span>, <span class="php-var">$params</span>);
</span><span id="231" class="l"><a class="l" href="#231">231: </a> }
</span><span id="232" class="l"><a class="l" href="#232">232: </a>
</span><span id="233" class="l"><a class="l" href="#233">233: </a> <span class="php-comment">/**
</span></span><span id="234" class="l"><a class="l" href="#234">234: </a><span class="php-comment"> * Get an individual list
</span></span><span id="235" class="l"><a class="l" href="#235">235: </a><span class="php-comment"> * @param string $accessToken - Valid access token
</span></span><span id="236" class="l"><a class="l" href="#236">236: </a><span class="php-comment"> * @param int $listId - Id of the list to retrieve
</span></span><span id="237" class="l"><a class="l" href="#237">237: </a><span class="php-comment"> * @return ContactList
</span></span><span id="238" class="l"><a class="l" href="#238">238: </a><span class="php-comment"> */</span>
</span><span id="239" class="l"><a class="l" href="#239">239: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getList" href="#_getList">getList</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$listId</span>)
</span><span id="240" class="l"><a class="l" href="#240">240: </a> {
</span><span id="241" class="l"><a class="l" href="#241">241: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->listService->getList(<span class="php-var">$accessToken</span>, <span class="php-var">$listId</span>);
</span><span id="242" class="l"><a class="l" href="#242">242: </a> }
</span><span id="243" class="l"><a class="l" href="#243">243: </a>
</span><span id="244" class="l"><a class="l" href="#244">244: </a> <span class="php-comment">/**
</span></span><span id="245" class="l"><a class="l" href="#245">245: </a><span class="php-comment"> * Add a new contact list to an account
</span></span><span id="246" class="l"><a class="l" href="#246">246: </a><span class="php-comment"> * @param string $accessToken - Valid access token
</span></span><span id="247" class="l"><a class="l" href="#247">247: </a><span class="php-comment"> * @param ContactList $list - List to add
</span></span><span id="248" class="l"><a class="l" href="#248">248: </a><span class="php-comment"> * @return ContactList
</span></span><span id="249" class="l"><a class="l" href="#249">249: </a><span class="php-comment"> */</span>
</span><span id="250" class="l"><a class="l" href="#250">250: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_addList" href="#_addList">addList</a>(<span class="php-var">$accessToken</span>, ContactList <span class="php-var">$list</span>)
</span><span id="251" class="l"><a class="l" href="#251">251: </a> {
</span><span id="252" class="l"><a class="l" href="#252">252: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->listService->addList(<span class="php-var">$accessToken</span>, <span class="php-var">$list</span>);
</span><span id="253" class="l"><a class="l" href="#253">253: </a> }
</span><span id="254" class="l"><a class="l" href="#254">254: </a>
</span><span id="255" class="l"><a class="l" href="#255">255: </a> <span class="php-comment">/**
</span></span><span id="256" class="l"><a class="l" href="#256">256: </a><span class="php-comment"> * Update a contact list
</span></span><span id="257" class="l"><a class="l" href="#257">257: </a><span class="php-comment"> * @param string $accessToken - Valid access token
</span></span><span id="258" class="l"><a class="l" href="#258">258: </a><span class="php-comment"> * @param ContactList $list - ContactList to update
</span></span><span id="259" class="l"><a class="l" href="#259">259: </a><span class="php-comment"> * @return ContactList
</span></span><span id="260" class="l"><a class="l" href="#260">260: </a><span class="php-comment"> */</span>
</span><span id="261" class="l"><a class="l" href="#261">261: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_updateList" href="#_updateList">updateList</a>(<span class="php-var">$accessToken</span>, ContactList <span class="php-var">$list</span>)
</span><span id="262" class="l"><a class="l" href="#262">262: </a> {
</span><span id="263" class="l"><a class="l" href="#263">263: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->listService->updateList(<span class="php-var">$accessToken</span>, <span class="php-var">$list</span>);
</span><span id="264" class="l"><a class="l" href="#264">264: </a> }
</span><span id="265" class="l"><a class="l" href="#265">265: </a>
</span><span id="266" class="l"><a class="l" href="#266">266: </a> <span class="php-comment">/**
</span></span><span id="267" class="l"><a class="l" href="#267">267: </a><span class="php-comment"> * Get contact that belong to a specific list
</span></span><span id="268" class="l"><a class="l" href="#268">268: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="269" class="l"><a class="l" href="#269">269: </a><span class="php-comment"> * @param mixed $list - Id of the list or a ContactList object
</span></span><span id="270" class="l"><a class="l" href="#270">270: </a><span class="php-comment"> * @param mixed $param - denotes the number of results per set, limited to 50, or a next parameter provided
</span></span><span id="271" class="l"><a class="l" href="#271">271: </a><span class="php-comment"> * from a previous getContactsFromList call
</span></span><span id="272" class="l"><a class="l" href="#272">272: </a><span class="php-comment"> * @return array
</span></span><span id="273" class="l"><a class="l" href="#273">273: </a><span class="php-comment"> * @throws IllegalArgumentException - if a ContactList object or id is not passed
</span></span><span id="274" class="l"><a class="l" href="#274">274: </a><span class="php-comment"> */</span>
</span><span id="275" class="l"><a class="l" href="#275">275: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getContactsFromList" href="#_getContactsFromList">getContactsFromList</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$list</span>, <span class="php-var">$param</span> = <span class="php-keyword1">null</span>)
</span><span id="276" class="l"><a class="l" href="#276">276: </a> {
</span><span id="277" class="l"><a class="l" href="#277">277: </a> <span class="php-var">$listId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$list</span>, <span class="php-quote">'ContactList'</span>);
</span><span id="278" class="l"><a class="l" href="#278">278: </a> <span class="php-var">$param</span> = <span class="php-var">$this</span>->determineParam(<span class="php-var">$param</span>);
</span><span id="279" class="l"><a class="l" href="#279">279: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->listService->getContactsFromList(<span class="php-var">$accessToken</span>, <span class="php-var">$listId</span>, <span class="php-var">$param</span>);
</span><span id="280" class="l"><a class="l" href="#280">280: </a> }
</span><span id="281" class="l"><a class="l" href="#281">281: </a>
</span><span id="282" class="l"><a class="l" href="#282">282: </a> <span class="php-comment">/**
</span></span><span id="283" class="l"><a class="l" href="#283">283: </a><span class="php-comment"> * Get a set of campaigns
</span></span><span id="284" class="l"><a class="l" href="#284">284: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="285" class="l"><a class="l" href="#285">285: </a><span class="php-comment"> * @param mixed $params - associative array of query parameters and values to append to the request.
</span></span><span id="286" class="l"><a class="l" href="#286">286: </a><span class="php-comment"> * Allow parameters include:
</span></span><span id="287" class="l"><a class="l" href="#287">287: </a><span class="php-comment"> * limit - Specifies the number of results displayed per page of output, from 1 - 500, default = 50.
</span></span><span id="288" class="l"><a class="l" href="#288">288: </a><span class="php-comment"> * modified_since - ISO-8601 formatted timestamp.
</span></span><span id="289" class="l"><a class="l" href="#289">289: </a><span class="php-comment"> * next - the next link returned from a previous paginated call. May only be used by itself.
</span></span><span id="290" class="l"><a class="l" href="#290">290: </a><span class="php-comment"> * email - the contact by email address to retrieve information for
</span></span><span id="291" class="l"><a class="l" href="#291">291: </a><span class="php-comment"> * @return ResultSet containing a results array of {@link Ctct\Components\EmailMarketing\Campaign}
</span></span><span id="292" class="l"><a class="l" href="#292">292: </a><span class="php-comment"> */</span>
</span><span id="293" class="l"><a class="l" href="#293">293: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getEmailCampaigns" href="#_getEmailCampaigns">getEmailCampaigns</a>(<span class="php-var">$accessToken</span>, <span class="php-keyword1">array</span> <span class="php-var">$params</span> = <span class="php-keyword1">array</span>())
</span><span id="294" class="l"><a class="l" href="#294">294: </a> {
</span><span id="295" class="l"><a class="l" href="#295">295: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->emailMarketingService->getCampaigns(<span class="php-var">$accessToken</span>, <span class="php-var">$params</span>);
</span><span id="296" class="l"><a class="l" href="#296">296: </a> }
</span><span id="297" class="l"><a class="l" href="#297">297: </a>
</span><span id="298" class="l"><a class="l" href="#298">298: </a> <span class="php-comment">/**
</span></span><span id="299" class="l"><a class="l" href="#299">299: </a><span class="php-comment"> * Get an individual campaign
</span></span><span id="300" class="l"><a class="l" href="#300">300: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="301" class="l"><a class="l" href="#301">301: </a><span class="php-comment"> * @param int $campaignId - Valid campaign id
</span></span><span id="302" class="l"><a class="l" href="#302">302: </a><span class="php-comment"> */</span>
</span><span id="303" class="l"><a class="l" href="#303">303: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getEmailCampaign" href="#_getEmailCampaign">getEmailCampaign</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$campaignId</span>)
</span><span id="304" class="l"><a class="l" href="#304">304: </a> {
</span><span id="305" class="l"><a class="l" href="#305">305: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->emailMarketingService->getCampaign(<span class="php-var">$accessToken</span>, <span class="php-var">$campaignId</span>);
</span><span id="306" class="l"><a class="l" href="#306">306: </a> }
</span><span id="307" class="l"><a class="l" href="#307">307: </a>
</span><span id="308" class="l"><a class="l" href="#308">308: </a> <span class="php-comment">/**
</span></span><span id="309" class="l"><a class="l" href="#309">309: </a><span class="php-comment"> * Delete an individual campaign
</span></span><span id="310" class="l"><a class="l" href="#310">310: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="311" class="l"><a class="l" href="#311">311: </a><span class="php-comment"> * @param mixed $campaign - Id of a campaign or a Campaign object itself
</span></span><span id="312" class="l"><a class="l" href="#312">312: </a><span class="php-comment"> * @throws IllegalArgumentException - if a Campaign object or campaign id is not passed
</span></span><span id="313" class="l"><a class="l" href="#313">313: </a><span class="php-comment"> * @return boolean
</span></span><span id="314" class="l"><a class="l" href="#314">314: </a><span class="php-comment"> */</span>
</span><span id="315" class="l"><a class="l" href="#315">315: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_deleteEmailCampaign" href="#_deleteEmailCampaign">deleteEmailCampaign</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$campaign</span>)
</span><span id="316" class="l"><a class="l" href="#316">316: </a> {
</span><span id="317" class="l"><a class="l" href="#317">317: </a> <span class="php-var">$campaignId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$campaign</span>, <span class="php-quote">'Campaign'</span>);
</span><span id="318" class="l"><a class="l" href="#318">318: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->emailMarketingService->deleteCampaign(<span class="php-var">$accessToken</span>, <span class="php-var">$campaignId</span>);
</span><span id="319" class="l"><a class="l" href="#319">319: </a> }
</span><span id="320" class="l"><a class="l" href="#320">320: </a>
</span><span id="321" class="l"><a class="l" href="#321">321: </a> <span class="php-comment">/**
</span></span><span id="322" class="l"><a class="l" href="#322">322: </a><span class="php-comment"> * Create a new campaign
</span></span><span id="323" class="l"><a class="l" href="#323">323: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="324" class="l"><a class="l" href="#324">324: </a><span class="php-comment"> * @param Campaign $campaign - Campaign to be created
</span></span><span id="325" class="l"><a class="l" href="#325">325: </a><span class="php-comment"> * @return Campaign - created campaign
</span></span><span id="326" class="l"><a class="l" href="#326">326: </a><span class="php-comment"> */</span>
</span><span id="327" class="l"><a class="l" href="#327">327: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_addEmailCampaign" href="#_addEmailCampaign">addEmailCampaign</a>(<span class="php-var">$accessToken</span>, Campaign <span class="php-var">$campaign</span>)
</span><span id="328" class="l"><a class="l" href="#328">328: </a> {
</span><span id="329" class="l"><a class="l" href="#329">329: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->emailMarketingService->addCampaign(<span class="php-var">$accessToken</span>, <span class="php-var">$campaign</span>);
</span><span id="330" class="l"><a class="l" href="#330">330: </a> }
</span><span id="331" class="l"><a class="l" href="#331">331: </a>
</span><span id="332" class="l"><a class="l" href="#332">332: </a> <span class="php-comment">/**
</span></span><span id="333" class="l"><a class="l" href="#333">333: </a><span class="php-comment"> * Update a specific campaign
</span></span><span id="334" class="l"><a class="l" href="#334">334: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="335" class="l"><a class="l" href="#335">335: </a><span class="php-comment"> * @param Campaign $campaign - Campaign to be updated
</span></span><span id="336" class="l"><a class="l" href="#336">336: </a><span class="php-comment"> * @return Campaign - updated campaign
</span></span><span id="337" class="l"><a class="l" href="#337">337: </a><span class="php-comment"> */</span>
</span><span id="338" class="l"><a class="l" href="#338">338: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_updateEmailCampaign" href="#_updateEmailCampaign">updateEmailCampaign</a>(<span class="php-var">$accessToken</span>, Campaign <span class="php-var">$campaign</span>)
</span><span id="339" class="l"><a class="l" href="#339">339: </a> {
</span><span id="340" class="l"><a class="l" href="#340">340: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->emailMarketingService->updateCampaign(<span class="php-var">$accessToken</span>, <span class="php-var">$campaign</span>);
</span><span id="341" class="l"><a class="l" href="#341">341: </a> }
</span><span id="342" class="l"><a class="l" href="#342">342: </a>
</span><span id="343" class="l"><a class="l" href="#343">343: </a> <span class="php-comment">/**
</span></span><span id="344" class="l"><a class="l" href="#344">344: </a><span class="php-comment"> * Schedule a campaign to be sent
</span></span><span id="345" class="l"><a class="l" href="#345">345: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="346" class="l"><a class="l" href="#346">346: </a><span class="php-comment"> * @param mixed $campaign - Campaign to be updated
</span></span><span id="347" class="l"><a class="l" href="#347">347: </a><span class="php-comment"> * @param Schedule $schedule - Schedule to be associated with the provided campaign
</span></span><span id="348" class="l"><a class="l" href="#348">348: </a><span class="php-comment"> * @return Schedule schedule created
</span></span><span id="349" class="l"><a class="l" href="#349">349: </a><span class="php-comment"> */</span>
</span><span id="350" class="l"><a class="l" href="#350">350: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_addEmailCampaignSchedule" href="#_addEmailCampaignSchedule">addEmailCampaignSchedule</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$campaign</span>, Schedule <span class="php-var">$schedule</span>)
</span><span id="351" class="l"><a class="l" href="#351">351: </a> {
</span><span id="352" class="l"><a class="l" href="#352">352: </a> <span class="php-var">$campaignId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$campaign</span>, <span class="php-quote">'Campaign'</span>);
</span><span id="353" class="l"><a class="l" href="#353">353: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->campaignScheduleService->addSchedule(<span class="php-var">$accessToken</span>, <span class="php-var">$campaignId</span>, <span class="php-var">$schedule</span>);
</span><span id="354" class="l"><a class="l" href="#354">354: </a> }
</span><span id="355" class="l"><a class="l" href="#355">355: </a>
</span><span id="356" class="l"><a class="l" href="#356">356: </a> <span class="php-comment">/**
</span></span><span id="357" class="l"><a class="l" href="#357">357: </a><span class="php-comment"> * Get an array of schedules associated with a given campaign
</span></span><span id="358" class="l"><a class="l" href="#358">358: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="359" class="l"><a class="l" href="#359">359: </a><span class="php-comment"> * @param mixed $campaign - Campaign id or Campaign object itself
</span></span><span id="360" class="l"><a class="l" href="#360">360: </a><span class="php-comment"> * @return array
</span></span><span id="361" class="l"><a class="l" href="#361">361: </a><span class="php-comment"> */</span>
</span><span id="362" class="l"><a class="l" href="#362">362: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getEmailCampaignSchedules" href="#_getEmailCampaignSchedules">getEmailCampaignSchedules</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$campaign</span>)
</span><span id="363" class="l"><a class="l" href="#363">363: </a> {
</span><span id="364" class="l"><a class="l" href="#364">364: </a> <span class="php-var">$campaignId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$campaign</span>, <span class="php-quote">'Campaign'</span>);
</span><span id="365" class="l"><a class="l" href="#365">365: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->campaignScheduleService->getSchedules(<span class="php-var">$accessToken</span>, <span class="php-var">$campaignId</span>);
</span><span id="366" class="l"><a class="l" href="#366">366: </a> }
</span><span id="367" class="l"><a class="l" href="#367">367: </a>
</span><span id="368" class="l"><a class="l" href="#368">368: </a> <span class="php-comment">/**
</span></span><span id="369" class="l"><a class="l" href="#369">369: </a><span class="php-comment"> * Get a specific schedule associated with a given campaign
</span></span><span id="370" class="l"><a class="l" href="#370">370: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="371" class="l"><a class="l" href="#371">371: </a><span class="php-comment"> * @param mixed $campaign - Campaign id or Campaign object itself
</span></span><span id="372" class="l"><a class="l" href="#372">372: </a><span class="php-comment"> * @param mixed $schedule - Schedule id or Schedule object itself
</span></span><span id="373" class="l"><a class="l" href="#373">373: </a><span class="php-comment"> * @throws IllegalArgumentException
</span></span><span id="374" class="l"><a class="l" href="#374">374: </a><span class="php-comment"> * @return array
</span></span><span id="375" class="l"><a class="l" href="#375">375: </a><span class="php-comment"> */</span>
</span><span id="376" class="l"><a class="l" href="#376">376: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getEmailCampaignSchedule" href="#_getEmailCampaignSchedule">getEmailCampaignSchedule</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$campaign</span>, <span class="php-var">$schedule</span>)
</span><span id="377" class="l"><a class="l" href="#377">377: </a> {
</span><span id="378" class="l"><a class="l" href="#378">378: </a> <span class="php-var">$campaignId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$campaign</span>, <span class="php-quote">'Campaign'</span>);
</span><span id="379" class="l"><a class="l" href="#379">379: </a> <span class="php-var">$scheduleId</span> = <span class="php-keyword1">null</span>;
</span><span id="380" class="l"><a class="l" href="#380">380: </a>
</span><span id="381" class="l"><a class="l" href="#381">381: </a> <span class="php-keyword1">if</span> (<span class="php-var">$schedule</span> <span class="php-keyword1">instanceof</span> Schedule) {
</span><span id="382" class="l"><a class="l" href="#382">382: </a> <span class="php-var">$scheduleId</span> = <span class="php-var">$schedule</span>->id;
</span><span id="383" class="l"><a class="l" href="#383">383: </a> } <span class="php-keyword1">elseif</span> (<span class="php-keyword2">is_numeric</span>(<span class="php-var">$schedule</span>)) {
</span><span id="384" class="l"><a class="l" href="#384">384: </a> <span class="php-var">$scheduleId</span> = <span class="php-var">$schedule</span>;
</span><span id="385" class="l"><a class="l" href="#385">385: </a> } <span class="php-keyword1">else</span> {
</span><span id="386" class="l"><a class="l" href="#386">386: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> IllegalArgumentException(<span class="php-keyword2">sprintf</span>(Config::get(<span class="php-quote">'errors.id_or_object'</span>), <span class="php-quote">'Schedule'</span>));
</span><span id="387" class="l"><a class="l" href="#387">387: </a> }
</span><span id="388" class="l"><a class="l" href="#388">388: </a>
</span><span id="389" class="l"><a class="l" href="#389">389: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->campaignScheduleService->getSchedule(<span class="php-var">$accessToken</span>, <span class="php-var">$campaignId</span>, <span class="php-var">$scheduleId</span>);
</span><span id="390" class="l"><a class="l" href="#390">390: </a> }
</span><span id="391" class="l"><a class="l" href="#391">391: </a>
</span><span id="392" class="l"><a class="l" href="#392">392: </a> <span class="php-comment">/**
</span></span><span id="393" class="l"><a class="l" href="#393">393: </a><span class="php-comment"> * Update a specific schedule associated with a given campaign
</span></span><span id="394" class="l"><a class="l" href="#394">394: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="395" class="l"><a class="l" href="#395">395: </a><span class="php-comment"> * @param mixed $campaign - Campaign id or Campaign object itself
</span></span><span id="396" class="l"><a class="l" href="#396">396: </a><span class="php-comment"> * @param Schedule $schedule - Schedule to be updated
</span></span><span id="397" class="l"><a class="l" href="#397">397: </a><span class="php-comment"> * @return array
</span></span><span id="398" class="l"><a class="l" href="#398">398: </a><span class="php-comment"> */</span>
</span><span id="399" class="l"><a class="l" href="#399">399: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_updateEmailCampaignSchedule" href="#_updateEmailCampaignSchedule">updateEmailCampaignSchedule</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$campaign</span>, Schedule <span class="php-var">$schedule</span>)
</span><span id="400" class="l"><a class="l" href="#400">400: </a> {
</span><span id="401" class="l"><a class="l" href="#401">401: </a> <span class="php-var">$campaignId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$campaign</span>, <span class="php-quote">'Campaign'</span>);
</span><span id="402" class="l"><a class="l" href="#402">402: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->campaignScheduleService->updateSchedule(<span class="php-var">$accessToken</span>, <span class="php-var">$campaignId</span>, <span class="php-var">$schedule</span>);
</span><span id="403" class="l"><a class="l" href="#403">403: </a> }
</span><span id="404" class="l"><a class="l" href="#404">404: </a>
</span><span id="405" class="l"><a class="l" href="#405">405: </a> <span class="php-comment">/**
</span></span><span id="406" class="l"><a class="l" href="#406">406: </a><span class="php-comment"> * Delete a specific schedule associated with a given campaign
</span></span><span id="407" class="l"><a class="l" href="#407">407: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="408" class="l"><a class="l" href="#408">408: </a><span class="php-comment"> * @param mixed $campaign - Campaign id or Campaign object itself
</span></span><span id="409" class="l"><a class="l" href="#409">409: </a><span class="php-comment"> * @param mixed $schedule - Schedule id or Schedule object itself
</span></span><span id="410" class="l"><a class="l" href="#410">410: </a><span class="php-comment"> * @throws IllegalArgumentException
</span></span><span id="411" class="l"><a class="l" href="#411">411: </a><span class="php-comment"> * @return array
</span></span><span id="412" class="l"><a class="l" href="#412">412: </a><span class="php-comment"> */</span>
</span><span id="413" class="l"><a class="l" href="#413">413: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_deleteEmailCampaignSchedule" href="#_deleteEmailCampaignSchedule">deleteEmailCampaignSchedule</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$campaign</span>, <span class="php-var">$schedule</span>)
</span><span id="414" class="l"><a class="l" href="#414">414: </a> {
</span><span id="415" class="l"><a class="l" href="#415">415: </a> <span class="php-var">$campaignId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$campaign</span>, <span class="php-quote">'Campaign'</span>);
</span><span id="416" class="l"><a class="l" href="#416">416: </a> <span class="php-var">$scheduleId</span> = <span class="php-keyword1">null</span>;
</span><span id="417" class="l"><a class="l" href="#417">417: </a>
</span><span id="418" class="l"><a class="l" href="#418">418: </a> <span class="php-keyword1">if</span> (<span class="php-var">$schedule</span> <span class="php-keyword1">instanceof</span> Schedule) {
</span><span id="419" class="l"><a class="l" href="#419">419: </a> <span class="php-var">$scheduleId</span> = <span class="php-var">$schedule</span>->id;
</span><span id="420" class="l"><a class="l" href="#420">420: </a> } <span class="php-keyword1">elseif</span> (<span class="php-keyword2">is_numeric</span>(<span class="php-var">$schedule</span>)) {
</span><span id="421" class="l"><a class="l" href="#421">421: </a> <span class="php-var">$scheduleId</span> = <span class="php-var">$schedule</span>;
</span><span id="422" class="l"><a class="l" href="#422">422: </a> } <span class="php-keyword1">else</span> {
</span><span id="423" class="l"><a class="l" href="#423">423: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> IllegalArgumentException(<span class="php-keyword2">sprintf</span>(Config::get(<span class="php-quote">'errors.id_or_object'</span>), <span class="php-quote">'Schedule'</span>));
</span><span id="424" class="l"><a class="l" href="#424">424: </a> }
</span><span id="425" class="l"><a class="l" href="#425">425: </a>
</span><span id="426" class="l"><a class="l" href="#426">426: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->campaignScheduleService->deleteSchedule(<span class="php-var">$accessToken</span>, <span class="php-var">$campaignId</span>, <span class="php-var">$scheduleId</span>);
</span><span id="427" class="l"><a class="l" href="#427">427: </a> }
</span><span id="428" class="l"><a class="l" href="#428">428: </a>
</span><span id="429" class="l"><a class="l" href="#429">429: </a> <span class="php-comment">/**
</span></span><span id="430" class="l"><a class="l" href="#430">430: </a><span class="php-comment"> * Send a test send of a campaign
</span></span><span id="431" class="l"><a class="l" href="#431">431: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="432" class="l"><a class="l" href="#432">432: </a><span class="php-comment"> * @param mixed $emailCampaign - Campaign id or Campaign object itself
</span></span><span id="433" class="l"><a class="l" href="#433">433: </a><span class="php-comment"> * @param TestSend $test_send - test send details
</span></span><span id="434" class="l"><a class="l" href="#434">434: </a><span class="php-comment"> * @return TestSend
</span></span><span id="435" class="l"><a class="l" href="#435">435: </a><span class="php-comment"> */</span>
</span><span id="436" class="l"><a class="l" href="#436">436: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_sendEmailCampaignTest" href="#_sendEmailCampaignTest">sendEmailCampaignTest</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$campaign</span>, TestSend <span class="php-var">$test_send</span>)
</span><span id="437" class="l"><a class="l" href="#437">437: </a> {
</span><span id="438" class="l"><a class="l" href="#438">438: </a> <span class="php-var">$campaignId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$campaign</span>, <span class="php-quote">'Campaign'</span>);
</span><span id="439" class="l"><a class="l" href="#439">439: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->campaignScheduleService->sendTest(<span class="php-var">$accessToken</span>, <span class="php-var">$campaignId</span>, <span class="php-var">$test_send</span>);
</span><span id="440" class="l"><a class="l" href="#440">440: </a> }
</span><span id="441" class="l"><a class="l" href="#441">441: </a>
</span><span id="442" class="l"><a class="l" href="#442">442: </a> <span class="php-comment">/**
</span></span><span id="443" class="l"><a class="l" href="#443">443: </a><span class="php-comment"> * Get sends for a campaign
</span></span><span id="444" class="l"><a class="l" href="#444">444: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="445" class="l"><a class="l" href="#445">445: </a><span class="php-comment"> * @param mixed $campaign - Campaign id or Campaign object itself
</span></span><span id="446" class="l"><a class="l" href="#446">446: </a><span class="php-comment"> * @param mixed $params - associative array of query parameters and values to append to the request.
</span></span><span id="447" class="l"><a class="l" href="#447">447: </a><span class="php-comment"> * Allow parameters include:
</span></span><span id="448" class="l"><a class="l" href="#448">448: </a><span class="php-comment"> * limit - Specifies the number of results displayed per page of output, from 1 - 500, default = 50.
</span></span><span id="449" class="l"><a class="l" href="#449">449: </a><span class="php-comment"> * created_since - Used to retrieve a list of events since the date and time specified (in ISO-8601 format).
</span></span><span id="450" class="l"><a class="l" href="#450">450: </a><span class="php-comment"> * next - the next link returned from a previous paginated call. May only be used by itself.
</span></span><span id="451" class="l"><a class="l" href="#451">451: </a><span class="php-comment"> * @return ResultSet - Containing a results array of {@link Ctct\Components\CampaignTracking\SendActivity}
</span></span><span id="452" class="l"><a class="l" href="#452">452: </a><span class="php-comment"> */</span>
</span><span id="453" class="l"><a class="l" href="#453">453: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getEmailCampaignSends" href="#_getEmailCampaignSends">getEmailCampaignSends</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$campaign</span>, <span class="php-keyword1">array</span> <span class="php-var">$params</span> = <span class="php-keyword1">array</span>())
</span><span id="454" class="l"><a class="l" href="#454">454: </a> {
</span><span id="455" class="l"><a class="l" href="#455">455: </a> <span class="php-var">$campaignId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$campaign</span>, <span class="php-quote">'Campaign'</span>);
</span><span id="456" class="l"><a class="l" href="#456">456: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->campaignTrackingService->getSends(<span class="php-var">$accessToken</span>, <span class="php-var">$campaignId</span>, <span class="php-var">$params</span>);
</span><span id="457" class="l"><a class="l" href="#457">457: </a> }
</span><span id="458" class="l"><a class="l" href="#458">458: </a>
</span><span id="459" class="l"><a class="l" href="#459">459: </a> <span class="php-comment">/**
</span></span><span id="460" class="l"><a class="l" href="#460">460: </a><span class="php-comment"> * Get bounces for a campaign
</span></span><span id="461" class="l"><a class="l" href="#461">461: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="462" class="l"><a class="l" href="#462">462: </a><span class="php-comment"> * @param mixed $campaign - Campaign id or Campaign object itself
</span></span><span id="463" class="l"><a class="l" href="#463">463: </a><span class="php-comment"> * @param mixed $params - associative array of query parameters and values to append to the request.
</span></span><span id="464" class="l"><a class="l" href="#464">464: </a><span class="php-comment"> * Allow parameters include:
</span></span><span id="465" class="l"><a class="l" href="#465">465: </a><span class="php-comment"> * limit - Specifies the number of results displayed per page of output, from 1 - 500, default = 50.
</span></span><span id="466" class="l"><a class="l" href="#466">466: </a><span class="php-comment"> * created_since - Used to retrieve a list of events since the date and time specified (in ISO-8601 format).
</span></span><span id="467" class="l"><a class="l" href="#467">467: </a><span class="php-comment"> * next - the next link returned from a previous paginated call. May only be used by itself.
</span></span><span id="468" class="l"><a class="l" href="#468">468: </a><span class="php-comment"> * @return ResultSet - Containing a results array of {@link Ctct\Components\CampaignTracking\BounceActivity}
</span></span><span id="469" class="l"><a class="l" href="#469">469: </a><span class="php-comment"> */</span>
</span><span id="470" class="l"><a class="l" href="#470">470: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getEmailCampaignBounces" href="#_getEmailCampaignBounces">getEmailCampaignBounces</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$campaign</span>, <span class="php-keyword1">array</span> <span class="php-var">$params</span> = <span class="php-keyword1">array</span>())
</span><span id="471" class="l"><a class="l" href="#471">471: </a> {
</span><span id="472" class="l"><a class="l" href="#472">472: </a> <span class="php-var">$campaignId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$campaign</span>, <span class="php-quote">'Campaign'</span>);
</span><span id="473" class="l"><a class="l" href="#473">473: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->campaignTrackingService->getBounces(<span class="php-var">$accessToken</span>, <span class="php-var">$campaignId</span>, <span class="php-var">$params</span>);
</span><span id="474" class="l"><a class="l" href="#474">474: </a> }
</span><span id="475" class="l"><a class="l" href="#475">475: </a>
</span><span id="476" class="l"><a class="l" href="#476">476: </a> <span class="php-comment">/**
</span></span><span id="477" class="l"><a class="l" href="#477">477: </a><span class="php-comment"> * Get clicks for a campaign
</span></span><span id="478" class="l"><a class="l" href="#478">478: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="479" class="l"><a class="l" href="#479">479: </a><span class="php-comment"> * @param mixed $emailCampaign - Campaign id or Campaign object itself
</span></span><span id="480" class="l"><a class="l" href="#480">480: </a><span class="php-comment"> * @param mixed $params - associative array of query parameters and values to append to the request.
</span></span><span id="481" class="l"><a class="l" href="#481">481: </a><span class="php-comment"> * Allow parameters include:
</span></span><span id="482" class="l"><a class="l" href="#482">482: </a><span class="php-comment"> * limit - Specifies the number of results displayed per page of output, from 1 - 500, default = 50.
</span></span><span id="483" class="l"><a class="l" href="#483">483: </a><span class="php-comment"> * created_since - Used to retrieve a list of events since the date and time specified (in ISO-8601 format).
</span></span><span id="484" class="l"><a class="l" href="#484">484: </a><span class="php-comment"> * next - the next link returned from a previous paginated call. May only be used by itself.
</span></span><span id="485" class="l"><a class="l" href="#485">485: </a><span class="php-comment"> * @return ResultSet - Containing a results array of {@link Ctct\Components\CampaignTracking\ClickActivity}
</span></span><span id="486" class="l"><a class="l" href="#486">486: </a><span class="php-comment"> */</span>
</span><span id="487" class="l"><a class="l" href="#487">487: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getEmailCampaignClicks" href="#_getEmailCampaignClicks">getEmailCampaignClicks</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$campaign</span>, <span class="php-keyword1">array</span> <span class="php-var">$params</span> = <span class="php-keyword1">array</span>())
</span><span id="488" class="l"><a class="l" href="#488">488: </a> {
</span><span id="489" class="l"><a class="l" href="#489">489: </a> <span class="php-var">$campaignId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$campaign</span>, <span class="php-quote">'Campaign'</span>);
</span><span id="490" class="l"><a class="l" href="#490">490: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->campaignTrackingService->getClicks(<span class="php-var">$accessToken</span>, <span class="php-var">$campaignId</span>, <span class="php-var">$params</span>);
</span><span id="491" class="l"><a class="l" href="#491">491: </a> }
</span><span id="492" class="l"><a class="l" href="#492">492: </a>
</span><span id="493" class="l"><a class="l" href="#493">493: </a> <span class="php-comment">/**
</span></span><span id="494" class="l"><a class="l" href="#494">494: </a><span class="php-comment"> * Get opens for a campaign
</span></span><span id="495" class="l"><a class="l" href="#495">495: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="496" class="l"><a class="l" href="#496">496: </a><span class="php-comment"> * @param mixed $campaign - Campaign id or Campaign object itself
</span></span><span id="497" class="l"><a class="l" href="#497">497: </a><span class="php-comment"> * @param mixed $params - associative array of query parameters and values to append to the request.
</span></span><span id="498" class="l"><a class="l" href="#498">498: </a><span class="php-comment"> * Allow parameters include:
</span></span><span id="499" class="l"><a class="l" href="#499">499: </a><span class="php-comment"> * limit - Specifies the number of results displayed per page of output, from 1 - 500, default = 50.
</span></span><span id="500" class="l"><a class="l" href="#500">500: </a><span class="php-comment"> * created_since - Used to retrieve a list of events since the date and time specified (in ISO-8601 format).
</span></span><span id="501" class="l"><a class="l" href="#501">501: </a><span class="php-comment"> * next - the next link returned from a previous paginated call. May only be used by itself.
</span></span><span id="502" class="l"><a class="l" href="#502">502: </a><span class="php-comment"> * @return ResultSet - Containing a results array of {@link Ctct\Components\CampaignTracking\OpenActivity}
</span></span><span id="503" class="l"><a class="l" href="#503">503: </a><span class="php-comment"> */</span>
</span><span id="504" class="l"><a class="l" href="#504">504: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getEmailCampaignOpens" href="#_getEmailCampaignOpens">getEmailCampaignOpens</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$campaign</span>, <span class="php-keyword1">array</span> <span class="php-var">$params</span> = <span class="php-keyword1">array</span>())
</span><span id="505" class="l"><a class="l" href="#505">505: </a> {
</span><span id="506" class="l"><a class="l" href="#506">506: </a> <span class="php-var">$campaignId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$campaign</span>, <span class="php-quote">'Campaign'</span>);
</span><span id="507" class="l"><a class="l" href="#507">507: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->campaignTrackingService->getOpens(<span class="php-var">$accessToken</span>, <span class="php-var">$campaignId</span>, <span class="php-var">$params</span>);
</span><span id="508" class="l"><a class="l" href="#508">508: </a> }
</span><span id="509" class="l"><a class="l" href="#509">509: </a>
</span><span id="510" class="l"><a class="l" href="#510">510: </a> <span class="php-comment">/**
</span></span><span id="511" class="l"><a class="l" href="#511">511: </a><span class="php-comment"> * Get forwards for a campaign
</span></span><span id="512" class="l"><a class="l" href="#512">512: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="513" class="l"><a class="l" href="#513">513: </a><span class="php-comment"> * @param mixed $campaign - Campaign id or Campaign object itself
</span></span><span id="514" class="l"><a class="l" href="#514">514: </a><span class="php-comment"> * @param mixed $params - associative array of query parameters and values to append to the request.
</span></span><span id="515" class="l"><a class="l" href="#515">515: </a><span class="php-comment"> * Allow parameters include:
</span></span><span id="516" class="l"><a class="l" href="#516">516: </a><span class="php-comment"> * limit - Specifies the number of results displayed per page of output, from 1 - 500, default = 50.
</span></span><span id="517" class="l"><a class="l" href="#517">517: </a><span class="php-comment"> * created_since - Used to retrieve a list of events since the date and time specified (in ISO-8601 format).
</span></span><span id="518" class="l"><a class="l" href="#518">518: </a><span class="php-comment"> * next - the next link returned from a previous paginated call. May only be used by itself.
</span></span><span id="519" class="l"><a class="l" href="#519">519: </a><span class="php-comment"> * @return ResultSet - Containing a results array of {@link Ctct\Components\CampaignTracking\ForwardActivity}
</span></span><span id="520" class="l"><a class="l" href="#520">520: </a><span class="php-comment"> */</span>
</span><span id="521" class="l"><a class="l" href="#521">521: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getEmailCampaignForwards" href="#_getEmailCampaignForwards">getEmailCampaignForwards</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$campaign</span>, <span class="php-keyword1">array</span> <span class="php-var">$params</span> = <span class="php-keyword1">array</span>())
</span><span id="522" class="l"><a class="l" href="#522">522: </a> {
</span><span id="523" class="l"><a class="l" href="#523">523: </a> <span class="php-var">$campaignId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$campaign</span>, <span class="php-quote">'Campaign'</span>);
</span><span id="524" class="l"><a class="l" href="#524">524: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->campaignTrackingService->getForwards(<span class="php-var">$accessToken</span>, <span class="php-var">$campaignId</span>, <span class="php-var">$params</span>);
</span><span id="525" class="l"><a class="l" href="#525">525: </a> }
</span><span id="526" class="l"><a class="l" href="#526">526: </a>
</span><span id="527" class="l"><a class="l" href="#527">527: </a> <span class="php-comment">/**
</span></span><span id="528" class="l"><a class="l" href="#528">528: </a><span class="php-comment"> * Get unsubscribes for a campaign
</span></span><span id="529" class="l"><a class="l" href="#529">529: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="530" class="l"><a class="l" href="#530">530: </a><span class="php-comment"> * @param mixed $campaign - Campaign id or Campaign object itself
</span></span><span id="531" class="l"><a class="l" href="#531">531: </a><span class="php-comment"> * @param mixed $params - associative array of query parameters and values to append to the request.
</span></span><span id="532" class="l"><a class="l" href="#532">532: </a><span class="php-comment"> * Allow parameters include:
</span></span><span id="533" class="l"><a class="l" href="#533">533: </a><span class="php-comment"> * limit - Specifies the number of results displayed per page of output, from 1 - 500, default = 50.
</span></span><span id="534" class="l"><a class="l" href="#534">534: </a><span class="php-comment"> * created_since - Used to retrieve a list of events since the date and time specified (in ISO-8601 format).
</span></span><span id="535" class="l"><a class="l" href="#535">535: </a><span class="php-comment"> * next - the next link returned from a previous paginated call. May only be used by itself.
</span></span><span id="536" class="l"><a class="l" href="#536">536: </a><span class="php-comment"> * @return ResultSet - Containing a results array of {@link Ctct\Components\CampaignTracking\UnsubscribeActivity}
</span></span><span id="537" class="l"><a class="l" href="#537">537: </a><span class="php-comment"> */</span>
</span><span id="538" class="l"><a class="l" href="#538">538: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getEmailCampaignUnsubscribes" href="#_getEmailCampaignUnsubscribes">getEmailCampaignUnsubscribes</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$campaign</span>, <span class="php-keyword1">array</span> <span class="php-var">$params</span> = <span class="php-keyword1">array</span>())
</span><span id="539" class="l"><a class="l" href="#539">539: </a> {
</span><span id="540" class="l"><a class="l" href="#540">540: </a> <span class="php-var">$campaignId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$campaign</span>, <span class="php-quote">'Campaign'</span>);
</span><span id="541" class="l"><a class="l" href="#541">541: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->campaignTrackingService->getUnsubscribes(<span class="php-var">$accessToken</span>, <span class="php-var">$campaignId</span>, <span class="php-var">$params</span>);
</span><span id="542" class="l"><a class="l" href="#542">542: </a> }
</span><span id="543" class="l"><a class="l" href="#543">543: </a>
</span><span id="544" class="l"><a class="l" href="#544">544: </a> <span class="php-comment">/**
</span></span><span id="545" class="l"><a class="l" href="#545">545: </a><span class="php-comment"> * Get a reporting summary for a campaign
</span></span><span id="546" class="l"><a class="l" href="#546">546: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="547" class="l"><a class="l" href="#547">547: </a><span class="php-comment"> * @param mixed $campaign - Campaign id or Campaign object itself
</span></span><span id="548" class="l"><a class="l" href="#548">548: </a><span class="php-comment"> * @return TrackingSummary
</span></span><span id="549" class="l"><a class="l" href="#549">549: </a><span class="php-comment"> */</span>
</span><span id="550" class="l"><a class="l" href="#550">550: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getEmailCampaignSummaryReport" href="#_getEmailCampaignSummaryReport">getEmailCampaignSummaryReport</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$campaign</span>)
</span><span id="551" class="l"><a class="l" href="#551">551: </a> {
</span><span id="552" class="l"><a class="l" href="#552">552: </a> <span class="php-var">$campaignId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$campaign</span>, <span class="php-quote">'Campaign'</span>);
</span><span id="553" class="l"><a class="l" href="#553">553: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->campaignTrackingService->getSummary(<span class="php-var">$accessToken</span>, <span class="php-var">$campaignId</span>);
</span><span id="554" class="l"><a class="l" href="#554">554: </a> }
</span><span id="555" class="l"><a class="l" href="#555">555: </a>
</span><span id="556" class="l"><a class="l" href="#556">556: </a> <span class="php-comment">/**
</span></span><span id="557" class="l"><a class="l" href="#557">557: </a><span class="php-comment"> * Get sends for a Contact
</span></span><span id="558" class="l"><a class="l" href="#558">558: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="559" class="l"><a class="l" href="#559">559: </a><span class="php-comment"> * @param mixed $contact - Contact id or Contact object itself
</span></span><span id="560" class="l"><a class="l" href="#560">560: </a><span class="php-comment"> * @param mixed $params - associative array of query parameters and values to append to the request.
</span></span><span id="561" class="l"><a class="l" href="#561">561: </a><span class="php-comment"> * Allow parameters include:
</span></span><span id="562" class="l"><a class="l" href="#562">562: </a><span class="php-comment"> * limit - Specifies the number of results displayed per page of output, from 1 - 500, default = 50.
</span></span><span id="563" class="l"><a class="l" href="#563">563: </a><span class="php-comment"> * created_since - Used to retrieve a list of events since the date and time specified (in ISO-8601 format).
</span></span><span id="564" class="l"><a class="l" href="#564">564: </a><span class="php-comment"> * next - the next link returned from a previous paginated call. May only be used by itself.
</span></span><span id="565" class="l"><a class="l" href="#565">565: </a><span class="php-comment"> * @return ResultSet - Containing a results array of {@link Ctct\Components\Tracking\SendActivity}
</span></span><span id="566" class="l"><a class="l" href="#566">566: </a><span class="php-comment"> */</span>
</span><span id="567" class="l"><a class="l" href="#567">567: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getContactSends" href="#_getContactSends">getContactSends</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$contact</span>, <span class="php-keyword1">array</span> <span class="php-var">$params</span> = <span class="php-keyword1">array</span>())
</span><span id="568" class="l"><a class="l" href="#568">568: </a> {
</span><span id="569" class="l"><a class="l" href="#569">569: </a> <span class="php-var">$contactId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$contact</span>, <span class="php-quote">'Contact'</span>);
</span><span id="570" class="l"><a class="l" href="#570">570: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->contactTrackingService->getSends(<span class="php-var">$accessToken</span>, <span class="php-var">$contactId</span>, <span class="php-var">$params</span>);
</span><span id="571" class="l"><a class="l" href="#571">571: </a> }
</span><span id="572" class="l"><a class="l" href="#572">572: </a>
</span><span id="573" class="l"><a class="l" href="#573">573: </a> <span class="php-comment">/**
</span></span><span id="574" class="l"><a class="l" href="#574">574: </a><span class="php-comment"> * Get bounces for a Contact
</span></span><span id="575" class="l"><a class="l" href="#575">575: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="576" class="l"><a class="l" href="#576">576: </a><span class="php-comment"> * @param mixed $contact - Contact id or Contact object itself
</span></span><span id="577" class="l"><a class="l" href="#577">577: </a><span class="php-comment"> * @param mixed $params - associative array of query parameters and values to append to the request.
</span></span><span id="578" class="l"><a class="l" href="#578">578: </a><span class="php-comment"> * Allow parameters include:
</span></span><span id="579" class="l"><a class="l" href="#579">579: </a><span class="php-comment"> * limit - Specifies the number of results displayed per page of output, from 1 - 500, default = 50.
</span></span><span id="580" class="l"><a class="l" href="#580">580: </a><span class="php-comment"> * created_since - Used to retrieve a list of events since the date and time specified (in ISO-8601 format).
</span></span><span id="581" class="l"><a class="l" href="#581">581: </a><span class="php-comment"> * next - the next link returned from a previous paginated call. May only be used by itself.
</span></span><span id="582" class="l"><a class="l" href="#582">582: </a><span class="php-comment"> * @return ResultSet - Containing a results array of {@link Ctct\Components\Tracking\BounceActivity}
</span></span><span id="583" class="l"><a class="l" href="#583">583: </a><span class="php-comment"> */</span>
</span><span id="584" class="l"><a class="l" href="#584">584: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getContactBounces" href="#_getContactBounces">getContactBounces</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$contact</span>, <span class="php-keyword1">array</span> <span class="php-var">$params</span> = <span class="php-keyword1">array</span>())
</span><span id="585" class="l"><a class="l" href="#585">585: </a> {
</span><span id="586" class="l"><a class="l" href="#586">586: </a> <span class="php-var">$contactId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$contact</span>, <span class="php-quote">'Contact'</span>);
</span><span id="587" class="l"><a class="l" href="#587">587: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->contactTrackingService->getBounces(<span class="php-var">$accessToken</span>, <span class="php-var">$contactId</span>, <span class="php-var">$params</span>);
</span><span id="588" class="l"><a class="l" href="#588">588: </a> }
</span><span id="589" class="l"><a class="l" href="#589">589: </a>
</span><span id="590" class="l"><a class="l" href="#590">590: </a> <span class="php-comment">/**
</span></span><span id="591" class="l"><a class="l" href="#591">591: </a><span class="php-comment"> * Get clicks for a Contact
</span></span><span id="592" class="l"><a class="l" href="#592">592: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="593" class="l"><a class="l" href="#593">593: </a><span class="php-comment"> * @param mixed $contact - Contact id or Contact object itself
</span></span><span id="594" class="l"><a class="l" href="#594">594: </a><span class="php-comment"> * @param mixed $params - associative array of query parameters and values to append to the request.
</span></span><span id="595" class="l"><a class="l" href="#595">595: </a><span class="php-comment"> * Allow parameters include:
</span></span><span id="596" class="l"><a class="l" href="#596">596: </a><span class="php-comment"> * limit - Specifies the number of results displayed per page of output, from 1 - 500, default = 50.
</span></span><span id="597" class="l"><a class="l" href="#597">597: </a><span class="php-comment"> * created_since - Used to retrieve a list of events since the date and time specified (in ISO-8601 format).
</span></span><span id="598" class="l"><a class="l" href="#598">598: </a><span class="php-comment"> * next - the next link returned from a previous paginated call. May only be used by itself.
</span></span><span id="599" class="l"><a class="l" href="#599">599: </a><span class="php-comment"> * @return ResultSet - Containing a results array of {@link Ctct\Components\Tracking\ClickActivity}
</span></span><span id="600" class="l"><a class="l" href="#600">600: </a><span class="php-comment"> */</span>
</span><span id="601" class="l"><a class="l" href="#601">601: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getContactClicks" href="#_getContactClicks">getContactClicks</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$contact</span>, <span class="php-keyword1">array</span> <span class="php-var">$params</span> = <span class="php-keyword1">array</span>())
</span><span id="602" class="l"><a class="l" href="#602">602: </a> {
</span><span id="603" class="l"><a class="l" href="#603">603: </a> <span class="php-var">$contactId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$contact</span>, <span class="php-quote">'Contact'</span>);
</span><span id="604" class="l"><a class="l" href="#604">604: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->contactTrackingService->getClicks(<span class="php-var">$accessToken</span>, <span class="php-var">$contactId</span>, <span class="php-var">$params</span>);
</span><span id="605" class="l"><a class="l" href="#605">605: </a> }
</span><span id="606" class="l"><a class="l" href="#606">606: </a>
</span><span id="607" class="l"><a class="l" href="#607">607: </a> <span class="php-comment">/**
</span></span><span id="608" class="l"><a class="l" href="#608">608: </a><span class="php-comment"> * Get opens for a Contact
</span></span><span id="609" class="l"><a class="l" href="#609">609: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="610" class="l"><a class="l" href="#610">610: </a><span class="php-comment"> * @param mixed $contact - Contact id or Contact object itself
</span></span><span id="611" class="l"><a class="l" href="#611">611: </a><span class="php-comment"> * @param mixed $params - associative array of query parameters and values to append to the request.
</span></span><span id="612" class="l"><a class="l" href="#612">612: </a><span class="php-comment"> * Allow parameters include:
</span></span><span id="613" class="l"><a class="l" href="#613">613: </a><span class="php-comment"> * limit - Specifies the number of results displayed per page of output, from 1 - 500, default = 50.
</span></span><span id="614" class="l"><a class="l" href="#614">614: </a><span class="php-comment"> * created_since - Used to retrieve a list of events since the date and time specified (in ISO-8601 format).
</span></span><span id="615" class="l"><a class="l" href="#615">615: </a><span class="php-comment"> * next - the next link returned from a previous paginated call. May only be used by itself.
</span></span><span id="616" class="l"><a class="l" href="#616">616: </a><span class="php-comment"> * @return ResultSet - Containing a results array of {@link Ctct\Components\Tracking\OpenActivity}
</span></span><span id="617" class="l"><a class="l" href="#617">617: </a><span class="php-comment"> */</span>
</span><span id="618" class="l"><a class="l" href="#618">618: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getContactOpens" href="#_getContactOpens">getContactOpens</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$contact</span>, <span class="php-keyword1">array</span> <span class="php-var">$params</span> = <span class="php-keyword1">array</span>())
</span><span id="619" class="l"><a class="l" href="#619">619: </a> {
</span><span id="620" class="l"><a class="l" href="#620">620: </a> <span class="php-var">$contactId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$contact</span>, <span class="php-quote">'Contact'</span>);
</span><span id="621" class="l"><a class="l" href="#621">621: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->contactTrackingService->getOpens(<span class="php-var">$accessToken</span>, <span class="php-var">$contactId</span>, <span class="php-var">$params</span>);
</span><span id="622" class="l"><a class="l" href="#622">622: </a> }
</span><span id="623" class="l"><a class="l" href="#623">623: </a>
</span><span id="624" class="l"><a class="l" href="#624">624: </a> <span class="php-comment">/**
</span></span><span id="625" class="l"><a class="l" href="#625">625: </a><span class="php-comment"> * Get forwards for a Contact
</span></span><span id="626" class="l"><a class="l" href="#626">626: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="627" class="l"><a class="l" href="#627">627: </a><span class="php-comment"> * @param mixed $contact - Contact id or Contact object itself
</span></span><span id="628" class="l"><a class="l" href="#628">628: </a><span class="php-comment"> * @param mixed $params - associative array of query parameters and values to append to the request.
</span></span><span id="629" class="l"><a class="l" href="#629">629: </a><span class="php-comment"> * Allow parameters include:
</span></span><span id="630" class="l"><a class="l" href="#630">630: </a><span class="php-comment"> * limit - Specifies the number of results displayed per page of output, from 1 - 500, default = 50.
</span></span><span id="631" class="l"><a class="l" href="#631">631: </a><span class="php-comment"> * created_since - Used to retrieve a list of events since the date and time specified (in ISO-8601 format).
</span></span><span id="632" class="l"><a class="l" href="#632">632: </a><span class="php-comment"> * next - the next link returned from a previous paginated call. May only be used by itself.
</span></span><span id="633" class="l"><a class="l" href="#633">633: </a><span class="php-comment"> * @return ResultSet - Containing a results array of {@link Ctct\Components\Tracking\ForwardActivity}
</span></span><span id="634" class="l"><a class="l" href="#634">634: </a><span class="php-comment"> */</span>
</span><span id="635" class="l"><a class="l" href="#635">635: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getContactForwards" href="#_getContactForwards">getContactForwards</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$contact</span>, <span class="php-keyword1">array</span> <span class="php-var">$params</span> = <span class="php-keyword1">array</span>())
</span><span id="636" class="l"><a class="l" href="#636">636: </a> {
</span><span id="637" class="l"><a class="l" href="#637">637: </a> <span class="php-var">$contactId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$contact</span>, <span class="php-quote">'Contact'</span>);
</span><span id="638" class="l"><a class="l" href="#638">638: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->contactTrackingService->getForwards(<span class="php-var">$accessToken</span>, <span class="php-var">$contactId</span>, <span class="php-var">$params</span>);
</span><span id="639" class="l"><a class="l" href="#639">639: </a> }
</span><span id="640" class="l"><a class="l" href="#640">640: </a>
</span><span id="641" class="l"><a class="l" href="#641">641: </a> <span class="php-comment">/**
</span></span><span id="642" class="l"><a class="l" href="#642">642: </a><span class="php-comment"> * Get opt outs for a Contact
</span></span><span id="643" class="l"><a class="l" href="#643">643: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="644" class="l"><a class="l" href="#644">644: </a><span class="php-comment"> * @param mixed $contact - Contact id or Contact object itself
</span></span><span id="645" class="l"><a class="l" href="#645">645: </a><span class="php-comment"> * @param mixed $params - associative array of query parameters and values to append to the request.
</span></span><span id="646" class="l"><a class="l" href="#646">646: </a><span class="php-comment"> * Allow parameters include:
</span></span><span id="647" class="l"><a class="l" href="#647">647: </a><span class="php-comment"> * limit - Specifies the number of results displayed per page of output, from 1 - 500, default = 50.
</span></span><span id="648" class="l"><a class="l" href="#648">648: </a><span class="php-comment"> * created_since - Used to retrieve a list of events since the date and time specified (in ISO-8601 format).
</span></span><span id="649" class="l"><a class="l" href="#649">649: </a><span class="php-comment"> * next - the next link returned from a previous paginated call. May only be used by itself.
</span></span><span id="650" class="l"><a class="l" href="#650">650: </a><span class="php-comment"> * @return ResultSet - Containing a results array of {@link Ctct\Components\Tracking\UnsubscribeActivity}
</span></span><span id="651" class="l"><a class="l" href="#651">651: </a><span class="php-comment"> */</span>
</span><span id="652" class="l"><a class="l" href="#652">652: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getContactUnsubscribes" href="#_getContactUnsubscribes">getContactUnsubscribes</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$contact</span>, <span class="php-keyword1">array</span> <span class="php-var">$params</span> = <span class="php-keyword1">array</span>())
</span><span id="653" class="l"><a class="l" href="#653">653: </a> {
</span><span id="654" class="l"><a class="l" href="#654">654: </a> <span class="php-var">$contactId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$contact</span>, <span class="php-quote">'Contact'</span>);
</span><span id="655" class="l"><a class="l" href="#655">655: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->contactTrackingService->getUnsubscribes(<span class="php-var">$accessToken</span>, <span class="php-var">$contactId</span>, <span class="php-var">$params</span>);
</span><span id="656" class="l"><a class="l" href="#656">656: </a> }
</span><span id="657" class="l"><a class="l" href="#657">657: </a>
</span><span id="658" class="l"><a class="l" href="#658">658: </a> <span class="php-comment">/**
</span></span><span id="659" class="l"><a class="l" href="#659">659: </a><span class="php-comment"> * Get verified addresses for the account
</span></span><span id="660" class="l"><a class="l" href="#660">660: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="661" class="l"><a class="l" href="#661">661: </a><span class="php-comment"> * @param string $status - Status to filter query results by
</span></span><span id="662" class="l"><a class="l" href="#662">662: </a><span class="php-comment"> * @return array of VerifiedEmailAddress objects
</span></span><span id="663" class="l"><a class="l" href="#663">663: </a><span class="php-comment"> */</span>
</span><span id="664" class="l"><a class="l" href="#664">664: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getVerifiedEmailAddresses" href="#_getVerifiedEmailAddresses">getVerifiedEmailAddresses</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$status</span> = <span class="php-keyword1">null</span>)
</span><span id="665" class="l"><a class="l" href="#665">665: </a> {
</span><span id="666" class="l"><a class="l" href="#666">666: </a> <span class="php-var">$params</span> = <span class="php-keyword1">array</span>();
</span><span id="667" class="l"><a class="l" href="#667">667: </a> <span class="php-keyword1">if</span> (<span class="php-var">$status</span>) {
</span><span id="668" class="l"><a class="l" href="#668">668: </a> <span class="php-var">$params</span>[<span class="php-quote">'status'</span>] = <span class="php-var">$status</span>;
</span><span id="669" class="l"><a class="l" href="#669">669: </a> }
</span><span id="670" class="l"><a class="l" href="#670">670: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->accountService->getVerifiedEmailAddresses(<span class="php-var">$accessToken</span>, <span class="php-var">$params</span>);
</span><span id="671" class="l"><a class="l" href="#671">671: </a> }
</span><span id="672" class="l"><a class="l" href="#672">672: </a>
</span><span id="673" class="l"><a class="l" href="#673">673: </a> <span class="php-comment">/**
</span></span><span id="674" class="l"><a class="l" href="#674">674: </a><span class="php-comment"> * Get a reporting summary for a Contact
</span></span><span id="675" class="l"><a class="l" href="#675">675: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="676" class="l"><a class="l" href="#676">676: </a><span class="php-comment"> * @param mixed $contact - Contact id or Contact object itself
</span></span><span id="677" class="l"><a class="l" href="#677">677: </a><span class="php-comment"> * @return TrackingSummary
</span></span><span id="678" class="l"><a class="l" href="#678">678: </a><span class="php-comment"> */</span>
</span><span id="679" class="l"><a class="l" href="#679">679: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getContactSummaryReport" href="#_getContactSummaryReport">getContactSummaryReport</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$contact</span>)
</span><span id="680" class="l"><a class="l" href="#680">680: </a> {
</span><span id="681" class="l"><a class="l" href="#681">681: </a> <span class="php-var">$contactId</span> = <span class="php-var">$this</span>->getArgumentId(<span class="php-var">$contact</span>, <span class="php-quote">'Contact'</span>);
</span><span id="682" class="l"><a class="l" href="#682">682: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->contactTrackingService->getSummary(<span class="php-var">$accessToken</span>, <span class="php-var">$contactId</span>);
</span><span id="683" class="l"><a class="l" href="#683">683: </a> }
</span><span id="684" class="l"><a class="l" href="#684">684: </a>
</span><span id="685" class="l"><a class="l" href="#685">685: </a> <span class="php-comment">/**
</span></span><span id="686" class="l"><a class="l" href="#686">686: </a><span class="php-comment"> * Get an array of activities
</span></span><span id="687" class="l"><a class="l" href="#687">687: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="688" class="l"><a class="l" href="#688">688: </a><span class="php-comment"> * @return array of {@link Ctct\Components\Activities\Activity}
</span></span><span id="689" class="l"><a class="l" href="#689">689: </a><span class="php-comment"> */</span>
</span><span id="690" class="l"><a class="l" href="#690">690: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getActivities" href="#_getActivities">getActivities</a>(<span class="php-var">$accessToken</span>)
</span><span id="691" class="l"><a class="l" href="#691">691: </a> {
</span><span id="692" class="l"><a class="l" href="#692">692: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->activityService->getActivities(<span class="php-var">$accessToken</span>);
</span><span id="693" class="l"><a class="l" href="#693">693: </a> }
</span><span id="694" class="l"><a class="l" href="#694">694: </a>
</span><span id="695" class="l"><a class="l" href="#695">695: </a> <span class="php-comment">/**
</span></span><span id="696" class="l"><a class="l" href="#696">696: </a><span class="php-comment"> * Get a single activity by id
</span></span><span id="697" class="l"><a class="l" href="#697">697: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="698" class="l"><a class="l" href="#698">698: </a><span class="php-comment"> * @param string $activityId - Activity id
</span></span><span id="699" class="l"><a class="l" href="#699">699: </a><span class="php-comment"> * @return {@link Ctct\Components\Activities\Activity}
</span></span><span id="700" class="l"><a class="l" href="#700">700: </a><span class="php-comment"> */</span>
</span><span id="701" class="l"><a class="l" href="#701">701: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getActivity" href="#_getActivity">getActivity</a>(<span class="php-var">$accessToken</span>, <span class="php-var">$activityId</span>)
</span><span id="702" class="l"><a class="l" href="#702">702: </a> {
</span><span id="703" class="l"><a class="l" href="#703">703: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->activityService->getActivity(<span class="php-var">$accessToken</span>, <span class="php-var">$activityId</span>);
</span><span id="704" class="l"><a class="l" href="#704">704: </a> }
</span><span id="705" class="l"><a class="l" href="#705">705: </a>
</span><span id="706" class="l"><a class="l" href="#706">706: </a> <span class="php-comment">/**
</span></span><span id="707" class="l"><a class="l" href="#707">707: </a><span class="php-comment"> * Add an AddContacts Activity to add contacts in bulk
</span></span><span id="708" class="l"><a class="l" href="#708">708: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="709" class="l"><a class="l" href="#709">709: </a><span class="php-comment"> * @param AddContacts - Add Contacts Activity
</span></span><span id="710" class="l"><a class="l" href="#710">710: </a><span class="php-comment"> */</span>
</span><span id="711" class="l"><a class="l" href="#711">711: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_addCreateContactsActivity" href="#_addCreateContactsActivity">addCreateContactsActivity</a>(<span class="php-var">$accessToken</span>, AddContacts <span class="php-var">$addContactsActivity</span>)
</span><span id="712" class="l"><a class="l" href="#712">712: </a> {
</span><span id="713" class="l"><a class="l" href="#713">713: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->activityService->createAddContactsActivity(<span class="php-var">$accessToken</span>, <span class="php-var">$addContactsActivity</span>);
</span><span id="714" class="l"><a class="l" href="#714">714: </a> }
</span><span id="715" class="l"><a class="l" href="#715">715: </a>
</span><span id="716" class="l"><a class="l" href="#716">716: </a> <span class="php-comment">/**
</span></span><span id="717" class="l"><a class="l" href="#717">717: </a><span class="php-comment"> * Add an ClearLists Activity to remove all contacts from the provided lists
</span></span><span id="718" class="l"><a class="l" href="#718">718: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="719" class="l"><a class="l" href="#719">719: </a><span class="php-comment"> * @param AddContacts - Add Contacts Activity
</span></span><span id="720" class="l"><a class="l" href="#720">720: </a><span class="php-comment"> */</span>
</span><span id="721" class="l"><a class="l" href="#721">721: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_addClearListsActivity" href="#_addClearListsActivity">addClearListsActivity</a>(<span class="php-var">$accessToken</span>, <span class="php-keyword1">Array</span> <span class="php-var">$lists</span>)
</span><span id="722" class="l"><a class="l" href="#722">722: </a> {
</span><span id="723" class="l"><a class="l" href="#723">723: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->activityService->addClearListsActivity(<span class="php-var">$accessToken</span>, <span class="php-var">$lists</span>);
</span><span id="724" class="l"><a class="l" href="#724">724: </a> }
</span><span id="725" class="l"><a class="l" href="#725">725: </a>
</span><span id="726" class="l"><a class="l" href="#726">726: </a> <span class="php-comment">/**
</span></span><span id="727" class="l"><a class="l" href="#727">727: </a><span class="php-comment"> * Add a Remove Contacts From Lists Activity
</span></span><span id="728" class="l"><a class="l" href="#728">728: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="729" class="l"><a class="l" href="#729">729: </a><span class="php-comment"> * @param array $emailAddresses - email addresses to be removed
</span></span><span id="730" class="l"><a class="l" href="#730">730: </a><span class="php-comment"> * @param array $lists - lists to remove the provided email addresses from
</span></span><span id="731" class="l"><a class="l" href="#731">731: </a><span class="php-comment"> * @param AddContacts - Add Contacts Activity
</span></span><span id="732" class="l"><a class="l" href="#732">732: </a><span class="php-comment"> */</span>
</span><span id="733" class="l"><a class="l" href="#733">733: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_addRemoveContactsFromListsActivity" href="#_addRemoveContactsFromListsActivity">addRemoveContactsFromListsActivity</a>(<span class="php-var">$accessToken</span>, <span class="php-keyword1">Array</span> <span class="php-var">$emailAddresses</span>, <span class="php-keyword1">Array</span> <span class="php-var">$lists</span>)
</span><span id="734" class="l"><a class="l" href="#734">734: </a> {
</span><span id="735" class="l"><a class="l" href="#735">735: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->activityService->addRemoveContactsFromListsActivity(<span class="php-var">$accessToken</span>, <span class="php-var">$emailAddresses</span>, <span class="php-var">$lists</span>);
</span><span id="736" class="l"><a class="l" href="#736">736: </a> }
</span><span id="737" class="l"><a class="l" href="#737">737: </a>
</span><span id="738" class="l"><a class="l" href="#738">738: </a> <span class="php-comment">/**
</span></span><span id="739" class="l"><a class="l" href="#739">739: </a><span class="php-comment"> * Create an Export Contacts Activity
</span></span><span id="740" class="l"><a class="l" href="#740">740: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="741" class="l"><a class="l" href="#741">741: </a><span class="php-comment"> * @param ExportContacts $exportContacts
</span></span><span id="742" class="l"><a class="l" href="#742">742: </a><span class="php-comment"> * @return array - Array of all ActivitySummaryReports
</span></span><span id="743" class="l"><a class="l" href="#743">743: </a><span class="php-comment"> */</span>
</span><span id="744" class="l"><a class="l" href="#744">744: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_addExportContactsActivity" href="#_addExportContactsActivity">addExportContactsActivity</a>(<span class="php-var">$accessToken</span>, ExportContacts <span class="php-var">$exportContacts</span>)
</span><span id="745" class="l"><a class="l" href="#745">745: </a> {
</span><span id="746" class="l"><a class="l" href="#746">746: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->activityService->addExportContactsActivity(<span class="php-var">$accessToken</span>, <span class="php-var">$exportContacts</span>);
</span><span id="747" class="l"><a class="l" href="#747">747: </a> }
</span><span id="748" class="l"><a class="l" href="#748">748: </a>
</span><span id="749" class="l"><a class="l" href="#749">749: </a> <span class="php-comment">/**
</span></span><span id="750" class="l"><a class="l" href="#750">750: </a><span class="php-comment"> * Get the id of object, or attempt to convert the argument to an int
</span></span><span id="751" class="l"><a class="l" href="#751">751: </a><span class="php-comment"> * @param mixed $item - object or a numeric value
</span></span><span id="752" class="l"><a class="l" href="#752">752: </a><span class="php-comment"> * @param string $class_name - class name to test the given object against
</span></span><span id="753" class="l"><a class="l" href="#753">753: </a><span class="php-comment"> * @throws IllegalArgumentException - if the item is not an instance of the class name given, or cannot be
</span></span><span id="754" class="l"><a class="l" href="#754">754: </a><span class="php-comment"> * converted to a numeric value
</span></span><span id="755" class="l"><a class="l" href="#755">755: </a><span class="php-comment"> * @return int
</span></span><span id="756" class="l"><a class="l" href="#756">756: </a><span class="php-comment"> */</span>
</span><span id="757" class="l"><a class="l" href="#757">757: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_getArgumentId" href="#_getArgumentId">getArgumentId</a>(<span class="php-var">$item</span>, <span class="php-var">$className</span>)
</span><span id="758" class="l"><a class="l" href="#758">758: </a> {
</span><span id="759" class="l"><a class="l" href="#759">759: </a> <span class="php-var">$id</span> = <span class="php-keyword1">null</span>;
</span><span id="760" class="l"><a class="l" href="#760">760: </a>
</span><span id="761" class="l"><a class="l" href="#761">761: </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">is_numeric</span>(<span class="php-var">$item</span>)) {
</span><span id="762" class="l"><a class="l" href="#762">762: </a> <span class="php-var">$id</span> = <span class="php-var">$item</span>;
</span><span id="763" class="l"><a class="l" href="#763">763: </a> } <span class="php-keyword1">elseif</span> (<span class="php-keyword2">join</span>(<span class="php-quote">''</span>, <span class="php-keyword2">array_slice</span>(<span class="php-keyword2">explode</span>(<span class="php-quote">'\\'</span>, <span class="php-keyword2">get_class</span>(<span class="php-var">$item</span>)), -<span class="php-num">1</span>)) == <span class="php-var">$className</span>) {
</span><span id="764" class="l"><a class="l" href="#764">764: </a> <span class="php-var">$id</span> = <span class="php-var">$item</span>->id;
</span><span id="765" class="l"><a class="l" href="#765">765: </a> } <span class="php-keyword1">else</span> {
</span><span id="766" class="l"><a class="l" href="#766">766: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> IllegalArgumentException(<span class="php-keyword2">sprintf</span>(Config::get(<span class="php-quote">'errors.id_or_object'</span>), <span class="php-var">$className</span>));
</span><span id="767" class="l"><a class="l" href="#767">767: </a> }
</span><span id="768" class="l"><a class="l" href="#768">768: </a>
</span><span id="769" class="l"><a class="l" href="#769">769: </a> <span class="php-keyword1">return</span> <span class="php-var">$id</span>;
</span><span id="770" class="l"><a class="l" href="#770">770: </a> }
</span><span id="771" class="l"><a class="l" href="#771">771: </a>
</span><span id="772" class="l"><a class="l" href="#772">772: </a> <span class="php-comment">/**
</span></span><span id="773" class="l"><a class="l" href="#773">773: </a><span class="php-comment"> * Builds an array of query parameters to be added to the request
</span></span><span id="774" class="l"><a class="l" href="#774">774: </a><span class="php-comment"> * @param string $param
</span></span><span id="775" class="l"><a class="l" href="#775">775: </a><span class="php-comment"> * @return array
</span></span><span id="776" class="l"><a class="l" href="#776">776: </a><span class="php-comment"> */</span>
</span><span id="777" class="l"><a class="l" href="#777">777: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_determineParam" href="#_determineParam">determineParam</a>(<span class="php-var">$param</span>)
</span><span id="778" class="l"><a class="l" href="#778">778: </a> {
</span><span id="779" class="l"><a class="l" href="#779">779: </a> <span class="php-var">$params</span> = <span class="php-keyword1">array</span>();
</span><span id="780" class="l"><a class="l" href="#780">780: </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">substr</span>(<span class="php-var">$param</span>, <span class="php-num">0</span>, <span class="php-num">1</span>) === <span class="php-quote">'?'</span>) {
</span><span id="781" class="l"><a class="l" href="#781">781: </a> <span class="php-var">$param</span> = <span class="php-keyword2">substr</span>(<span class="php-var">$param</span>, <span class="php-num">1</span>);
</span><span id="782" class="l"><a class="l" href="#782">782: </a> <span class="php-keyword2">parse_str</span>(<span class="php-var">$param</span>, <span class="php-var">$params</span>);
</span><span id="783" class="l"><a class="l" href="#783">783: </a> } <span class="php-keyword1">else</span> {
</span><span id="784" class="l"><a class="l" href="#784">784: </a> <span class="php-var">$params</span>[<span class="php-quote">'limit'</span>] = <span class="php-var">$param</span>;
</span><span id="785" class="l"><a class="l" href="#785">785: </a> }
</span><span id="786" class="l"><a class="l" href="#786">786: </a> <span class="php-keyword1">return</span> <span class="php-var">$params</span>;
</span><span id="787" class="l"><a class="l" href="#787">787: </a> }
</span><span id="788" class="l"><a class="l" href="#788">788: </a>}
</span><span id="789" class="l"><a class="l" href="#789">789: </a></span></code></pre>
<div id="footer">
Appconnect PHP SDK API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>