V21.12.1 - 2021-12-21

Author: phpfui

src/ConstantContact/Definition/ABTestData.php

@@ -0,0 +1,20 @@
+<?php
+
+// Generated file. Do not edit by hand. Use update.php in project root.
+
+namespace PHPFUI\ConstantContact\Definition;
+
+/**
+ * @var string $alternative_subject The alternate email subject line to use for A/B testing.
+ * @var int $test_size The percentage of contact recipients to participate in the A/B Test. For example, if the value is 30, then 30% of contacts will receive the email campaign with subject line A, and 30% of contacts will receive the email campaign with subject line B. Valid values include <code>5</code> to <code>50</code> percent. Currently, A/B tests support subject line only.
+ * @var int $winner_wait_duration The number of hours Constant Contact waits after the A/B test is sent before determining the winning subject line. The winner is the subject line with the highest number of contact opens. After the winner is determined, Constant Contact automatically sends the email campaign with the winning subject line to all the remaining contacts, which did not participate in the A/B test.
+ */
+class ABTestData extends \PHPFUI\ConstantContact\Definition\Base
+	{
+	protected static array $fields = [
+		'alternative_subject' => 'string',
+		'test_size' => 'int',
+		'winner_wait_duration' => 'int',
+
+	];
+	}

src/ConstantContact/Definition/ResendToNonOpenersObject.php

@@ -0,0 +1,24 @@
+<?php
+
+// Generated file. Do not edit by hand. Use update.php in project root.
+
+namespace PHPFUI\ConstantContact\Definition;
+
+/**
+ * @var string $resend_subject The subject line for the resend email.
+ * @var int $delay_days The number of days to wait before Constant Contact resends the email. Valid values include <code>1</code> to <code>10</code> days. This property is mutually exclusive with <code>delay_minutes</code>. This value is only returned in the response results if the resend activity was created with <code>delay_days</code> or the <code>delay_minutes</code> equal to an exact day value.
+ * @var int $delay_minutes The number of minutes to wait before Constant Contact resends the email. There are 1,440 minutes in a day. Valid values includes a minimum of <code>720</code> (12 hours) and a maximum of <code>14,400</code> minutes (10 days). This property is mutually exclusive with <code>delay_days</code>.
+ * @var DateTime $resend_date The system generated ISO-8601 format date and time that Constant Contact resent the email to non-openers.
+ * @var string $resend_request_id For scheduled or sent resend to non-opener emails, this property is a unique identifier for the resend. For draft email campaign resend activities, the value of this property is <code>DRAFT</code>.
+ */
+class ResendToNonOpenersObject extends \PHPFUI\ConstantContact\Definition\Base
+	{
+	protected static array $fields = [
+		'resend_subject' => 'string',
+		'delay_days' => 'int',
+		'delay_minutes' => 'int',
+		'resend_date' => 'DateTime',
+		'resend_request_id' => 'string',
+
+	];
+	}

src/ConstantContact/V3/Activities/ContactExports.php

@@ -14,9 +14,16 @@ public function __construct(\PHPFUI\ConstantContact\Client $client)
 	/**
 	 * Export Contacts to a File
 	 *
-	 * Use this method to create an activity that exports contacts to a CSV
-	 * file. After Constant Contact finishes processing the activity, use the
-	 * `results` link in the response body to retrieve the CSV file.
+	 * Use this method to create an activity that exports contacts and contact
+	 * details to a CSV file. By default, all contacts are exported. To filter
+	 * contacts to export, specify the source to use, `contact_id`, `list_id`,
+	 * or `segment_id` (all mutually exclusive).
+	 * By default, all contact related fields are exported. Use the fields
+	 * array to only export specific contact fields. You must export `email_address`
+	 * to successfully export `email_optin_source`, `email_optin_date`, `email_optout_source`,
+	 * `email_optout_date`, or `email_optout_reason`.
+	 * After Constant Contact finishes processing the activity, use the `results`
+	 * link in the response body to retrieve the CSV file.
 	 *
 	 * @param \PHPFUI\ConstantContact\Definition\ContactsExport $body A JSON payload that specifies the contacts (rows in the CSV file) and contact properties (columns in the CSV file) you want to export.
 	 */

src/ConstantContact/V3/Emails/Activities/Abtest.php

@@ -0,0 +1,48 @@
+<?php
+
+// Generated file. Do not edit by hand. Use update.php in project root.
+
+namespace PHPFUI\ConstantContact\V3\Emails\Activities;
+
+class Abtest extends \PHPFUI\ConstantContact\Base
+	{
+	public function __construct(\PHPFUI\ConstantContact\Client $client)
+		{
+		parent::__construct($client, '/v3/emails/activities/{campaign_activity_id}/abtest');
+		}
+
+	/**
+	 * GET A/B Test Details for an Email Campaign Activity
+	 *
+	 * Use this method to get A/B test details for a primary email campaign
+	 * activity, such as the alternate email subject line, the contact test
+	 * percentage size, and the number of hours to wait to determine the winning
+	 * subject line to use. Currently, A/B tests support subject line only.
+	 *
+	 *
+	 * @param string $campaign_activity_id The unique ID for the primary email campaign activity.
+	 */
+	public function get(string $campaign_activity_id) : array
+		{
+
+		return $this->doGet(['campaign_activity_id' => $campaign_activity_id, ]);
+		}
+
+	/**
+	 * DELETE an A/B Test for an Email Campaign Activity
+	 *
+	 * Deletes an A/B Test on an primary email campaign activity. You can only
+	 * delete A/B tests that have a `current_status` of `Draft`. Deleting an
+	 * A/B tests reverts the email campaign activity `type` from A/B Test (code=
+	 * `57`) back to NewsLetter (code= `10`). Constant Contact uses the original
+	 * subject line, rather than the alternate A/B test subject line, when
+	 * an A/B test is deleted.
+	 *
+	 * @param string $campaign_activity_id The unique ID for the primary email campaign activity.
+	 */
+	public function delete(string $campaign_activity_id) : bool
+		{
+
+		return $this->doDelete(['campaign_activity_id' => $campaign_activity_id, ]);
+		}
+	}

src/ConstantContact/V3/Emails/Activities/NonOpenerResend.php

@@ -0,0 +1,28 @@
+<?php
+
+// Generated file. Do not edit by hand. Use update.php in project root.
+
+namespace PHPFUI\ConstantContact\V3\Emails\Activities;
+
+class NonOpenerResend extends \PHPFUI\ConstantContact\Base
+	{
+	public function __construct(\PHPFUI\ConstantContact\Client $client)
+		{
+		parent::__construct($client, '/v3/emails/activities/{campaign_activity_id}/non_opener_resends/{resend_request_id}');
+		}
+
+	/**
+	 * DELETE a Resend to Non Openers Activity
+	 *
+	 * Use this `DELETE` method to delete (unschedule) a resend to non openers
+	 * activity.
+	 *
+	 * @param string $campaign_activity_id The unique ID for the primary email campaign activity.
+	 * @param string $resend_request_id The unique ID associated with the resend for the email campaign activity (for example: `389093`). If the email campaign activity is currently in draft status, specify `DRAFT` as the ID.
+	 */
+	public function delete(string $campaign_activity_id, string $resend_request_id) : bool
+		{
+
+		return $this->doDelete(['campaign_activity_id' => $campaign_activity_id, 'resend_request_id' => $resend_request_id, ]);
+		}
+	}

src/ConstantContact/V3/Emails/Activities/NonOpenerResends.php

@@ -14,10 +14,10 @@ public function __construct(\PHPFUI\ConstantContact\Client $client)
 	/**
 	 * GET Details for a Resend to Non-openers Campaign Activity
 	 *
-	 * Get details about a resend to non-openers campaign activity. If a resend
+	 * Get details about a resend to non-openers campaign activity. If resend
 	 * activity does not exist for the specified `campaign_activity_id`, an
 	 * empty list is returned in the results. You can only create one resend
-	 * activity per  email campaign.
+	 * activity per email campaign.
 	 *
 	 * @param string $campaign_activity_id The unique ID for the primary email campaign activity.
 	 */
@@ -26,4 +26,31 @@ public function get(string $campaign_activity_id) : array
 
 		return $this->doGet(['campaign_activity_id' => $campaign_activity_id, ]);
 		}
+
+	/**
+	 * POST a Resend to Non-openers Campaign Activity
+	 *
+	 * Use this POST method to resend a primary campaign activity to contacts
+	 * that did not open a campaign activity that has a current `status` of
+	 * `Draft`, `Scheduled`, or `Done`. You can only create one resend activity
+	 * per email campaign.
+	 *
+	 * After an email campaign activity is sent to contacts, Constant Contact
+	 * waits the specified number of `delay_days` or `delay_minutes` (properties
+	 * are mutually exclusive) before resending to non-openers. If you set
+	 * both `delay_days` or `delay_minutes`, `delay_minutes` is ignored in
+	 * the request. You can resend to non-openers a minimum of twelve hours
+	 * (720 minutes) and a maximum of up to 10 days (or 10 x 1440 minutes)
+	 * after the initial send date.
+	 *
+	 *
+	 *
+	 * @param string $campaign_activity_id The unique ID for the primary email campaign activity.
+	 * @param \PHPFUI\ConstantContact\Definition\ResendToNonOpenersInput $resend_schedule A JSON request body that specifies when to resend the campaign activity to non-openers.
+	 */
+	public function post(string $campaign_activity_id, \PHPFUI\ConstantContact\Definition\ResendToNonOpenersInput $resend_schedule) : array
+		{
+
+		return $this->doPost(['campaign_activity_id' => $campaign_activity_id, 'resend_schedule' => $resend_schedule->getData(), ]);
+		}
 	}

src/ConstantContact/V3/Partner/Accounts.php

@@ -16,19 +16,32 @@ public function __construct(\PHPFUI\ConstantContact\Client $client)
 	 *
 	 * Get all Constant Contact client accounts managed under your technology
 	 * partner account. Use the `limit` query parameter to set the number of
-	 * accounts to return on each results page.
+	 * accounts to return on each results page. Use the `account_type` query
+	 * parameter to filter client account results by type: `all` (default),
+	 * `managed`, or `unmanaged`.
 	 * Only technology partners can access partner endpoints and partner endpoints
 	 * cannot be tested using the API reference tester.
 	 * For more use case information, see [Get all Partner Client Accounts](https://v3.developer.constantcontact.com/api_guide/partners_accts_get.html)
 	 * in the API guide.
 	 *
 	 * @param string $offset Depending on the `limit` you specify, the system determines the `offset` parameter to use (number of records to skip) and includes it in the link used to get the next page of results
 	 * @param string $limit The number of client accounts to return on each page of results. The default value is `50`. Entering a `limit` value less than the minimum (`10`) or greater than the maximum (`50`) is ignored and the system uses the default values. Depending on the `limit` you specify, the system determines the `offset` parameter to use (number of records to skip) and includes it in the link used to get the next page of results.
+	 * @param string $account_type Filters client account results by account type: `all` (default), `managed`, or `unmanaged`. Excluding the `account_type` query parameter returns all client accounts for the partner.
 	 */
-	public function get(?string $offset = null, ?string $limit = null) : array
+	public function get(?string $offset = null, ?string $limit = null, ?string $account_type = null) : array
 		{
 
-		return $this->doGet(['offset' => $offset, 'limit' => $limit, ]);
+		if (null !== $account_type)
+			{
+			$validValues = ['all', 'managed', 'unmanaged'];
+
+			if (! \in_array($account_type, $validValues))
+				{
+				throw new \PHPFUI\ConstantContact\Exception\InvalidValue("Parameter account_type with value '{$account_type}' is not one of (" . \implode(', ', $validValues) . ') in ' . __METHOD__);
+				}
+			}
+
+		return $this->doGet(['offset' => $offset, 'limit' => $limit, 'account_type' => $account_type, ]);
 		}
 
 	/**