V24.11.0 - 2024-11-02

Author: phpfui

src/ConstantContact/Definition/ActivityDeleteListResponse.php

@@ -7,13 +7,13 @@
 /**
  * @property \PHPFUI\ConstantContact\UUID $activity_id Unique ID for the delete list batch job.
  * @property string $state The state of the request:
- * <p><ul>
- * <li>initialized - request has been received</li>
- * <li>processing - request is being processed</li>
- * <li>completed - job completed</li>
- * <li>cancelled - request was cancelled</li>
- * <li>failed - job failed to complete</li>
- * <li>timed_out - the request timed out before completing"</li>
+ <p><ul>
+ <li>initialized - request has been received</li>
+ <li>processing - request is being processed</li>
+ <li>completed - job completed</li>
+ <li>cancelled - request was cancelled</li>
+ <li>failed - job failed to complete</li>
+ <li>timed_out - the request timed out before completing"</li>
  * </ul> </p>
  * @property \PHPFUI\ConstantContact\DateTime $created_at Date and time that the request was received, in ISO-8601 formmat.
  * @property \PHPFUI\ConstantContact\DateTime $updated_at Date and time that the request status was updated, in ISO-8601 format.

src/ConstantContact/Definition/ActivityExportStatus.php

@@ -7,13 +7,13 @@
 /**
  * @property \PHPFUI\ConstantContact\UUID $activity_id Unique ID for the activity.
  * @property string $state <p> The state of the request: <ul>
- * <li>initialized - request has been received</li>
- * <li>processing - request is being processed</li>
- * <li>completed - job completed</li>
- * <li>cancelled - request was cancelled</li>
- * <li>failed - job failed to complete</li>
- * <li>timed_out - the request timed out before completing"</li>
- * </ul> </p>
+ <li>initialized - request has been received</li>
+ <li>processing - request is being processed</li>
+ <li>completed - job completed</li>
+ <li>cancelled - request was cancelled</li>
+ <li>failed - job failed to complete</li>
+ <li>timed_out - the request timed out before completing"</li>
+ </ul> </p>
  * @property \PHPFUI\ConstantContact\DateTime $started_at Timestamp showing when we began processing the activity request, in ISO-8601 format.
  * @property \PHPFUI\ConstantContact\DateTime $completed_at Timestamp showing when we completed processing the activity, in ISO-8601 format.
  * @property \PHPFUI\ConstantContact\DateTime $created_at Timestamp showing when we created the activity, in ISO-8601 format.

src/ConstantContact/Definition/ActivityImport.php

@@ -7,8 +7,8 @@
 /**
  * @property \PHPFUI\ConstantContact\UUID $activity_id Unique ID for the activity.
  * @property string $state The state of the request:
- * <p><ul>
- * <li>initialized - request has been received</li>
+ <p><ul>
+  * <li>initialized - request has been received</li>
  * <li>processing - request is being processed</li>
  * <li>completed - job completed</li>
  * <li>cancelled - request was cancelled</li>

src/ConstantContact/Definition/EmailSendHistory.php

@@ -10,23 +10,23 @@
  * @property array $segment_ids The contact segments that Constant Contact sent the email campaign activity to as an array of <code>segment_id</code> integers.
  * @property int $count The number of contacts that Constant Contact sent this email campaign activity to. This property is specific to each send history object. When you resend an email campaign activity, Constant Contact only sends it to new contacts in the contact lists or segments you are using.
  * @property \PHPFUI\ConstantContact\DateTime $run_date The system generated date and time that Constant Contact sent the email campaign activity to contacts in ISO-8601 format.
- * @property string $send_status The send status for the email campaign activity. Valid values are: <ul>
+ * @property string $send_status The send status for the email campaign activity. Valid values are: <ul> 
  * <li><code>COMPLETED</code>: Constant Contact successfully sent the email campaign activity.</li>
  * <li><code>ERRORED</code>: Constant Contact encountered an error when sending the email campaign activity.<li> * </ul>
  * @property int $reason_code The reason why the send attempt completed or encountered an error. This method returns <code>0</code> if Constant Contact successfully sent the email campaign activity to contacts. Possible <code>reason_code</code> values are: <ul>
- * <li>0 — Constant Contact successfully sent the email to contacts.</li>
- * <li>1 — An error occurred when sending this email. Try scheduling it again, or contact <a href='http://support.constantcontact.com' target='_blank'>Customer Support</a>.</li>
- * <li>2 — We were unable to send the email. Please contact our <a href='http://knowledgebase.constantcontact.com/articles/KnowledgeBase/5782-contact-an-account-review-and-deliverability-specialist' target='_blank'>Account Review Team</a> for more information.</li>
- * <li>3 — This Constant Contact account cannot currently send emails. This can be due to billing or product expiration.</li>
- * <li>4 — You're not able to send the email to that many contacts. Remove contacts from the contact lists you are using or select a list with fewer contacts.</li>
- * <li>5 — The email is currently in staging. For more information, see the <a href='http://knowledgebase.constantcontact.com/articles/KnowledgeBase/7402-email-staging' target='_blank>Email Staging Knowledge Base article</a>.</li>
- * <li>6 — Constant Contact was unable to finish sending this email to all of the contacts on your list. Please contact <a href='http://support.constantcontact.com' target='_blank'>Customer Support</a> for more information.</li>
- * <li>7 — The email contains invalid images. This can be caused when one or more images in the email are longer available in your image library.</li>
- * <li>8 — The email contains a link URL that exceeds 1005 characters.</li>
- * <li>9 — Constant Contact was unable to verify your authenticated Sender address. Please contact <a href='http://support.constantcontact.com' target='_blank'>Customer Support</a> for more information.</li>
- * <li>10 — Constant Contact was unable to verify your authenticated Sender address. Please contact <a href='http://support.constantcontact.com' target='_blank'>Customer Support</a> for more information.</li>
- * <li>11 — This Constant Contact account cannot send survey invitations.</li>
- * <li>12 — Constant Contact attempted to send the email, but there were no eligible contacts to send it to. This can be caused by an invalid contact list, a contact list with no contacts, or a contact list with no new contacts during a resend. This method displays <code>reason_code</code> 12 as a send attempt with a <code>send_status</code> of COMPLETED and a <code>count</code> of 0.</li> * </ul>
+   * <li>0 — Constant Contact successfully sent the email to contacts.</li>
+   * <li>1 — An error occurred when sending this email. Try scheduling it again, or contact <a href='http://support.constantcontact.com' target='_blank'>Customer Support</a>.</li>
+   * <li>2 — We were unable to send the email. Please contact our <a href='http://knowledgebase.constantcontact.com/articles/KnowledgeBase/5782-contact-an-account-review-and-deliverability-specialist' target='_blank'>Account Review Team</a> for more information.</li>
+   * <li>3 — This Constant Contact account cannot currently send emails. This can be due to billing or product expiration.</li>
+   * <li>4 — You're not able to send the email to that many contacts. Remove contacts from the contact lists you are using or select a list with fewer contacts.</li>
+   * <li>5 — The email is currently in staging. For more information, see the <a href='http://knowledgebase.constantcontact.com/articles/KnowledgeBase/7402-email-staging' target='_blank>Email Staging Knowledge Base article</a>.</li>
+   * <li>6 — Constant Contact was unable to finish sending this email to all of the contacts on your list. Please contact <a href='http://support.constantcontact.com' target='_blank'>Customer Support</a> for more information.</li>
+   * <li>7 — The email contains invalid images. This can be caused when one or more images in the email are longer available in your image library.</li>
+   * <li>8 — The email contains a link URL that exceeds 1005 characters.</li>
+   * <li>9 — Constant Contact was unable to verify your authenticated Sender address. Please contact <a href='http://support.constantcontact.com' target='_blank'>Customer Support</a> for more information.</li>
+   * <li>10 — Constant Contact was unable to verify your authenticated Sender address. Please contact <a href='http://support.constantcontact.com' target='_blank'>Customer Support</a> for more information.</li>
+   * <li>11 — This Constant Contact account cannot send survey invitations.</li>
+   * <li>12 — Constant Contact attempted to send the email, but there were no eligible contacts to send it to. This can be caused by an invalid contact list, a contact list with no contacts, or a contact list with no new contacts during a resend. This method displays <code>reason_code</code> 12 as a send attempt with a <code>send_status</code> of COMPLETED and a <code>count</code> of 0.</li> * </ul>
  */
 class EmailSendHistory extends \PHPFUI\ConstantContact\Definition\Base
 	{

src/ConstantContact/Definition/PlanInfo.php

@@ -8,9 +8,9 @@
  * @property string $plan_type Use this property to update the client account billing plan to a different billing plan. After changing the <code>plan_type</code> from <code>TRIAL</code> to any other billing plan type, you cannot change it back to <code>TRIAL</code>.
  * <ul>
  * <li><code>TRIAL</code>: A non-billable account with an expiration date that allows clients to try Constant Contact product features.</li>
- * <li><code>GOLD</code>: A billable client account plan.</li>
- * <li><code>SILVER</code>: A billable client account plan.</li>
- * <li><code>BRONZE</code>: A billable client account plan.</li>
+  * <li><code>GOLD</code>: A billable client account plan.</li>
+  * <li><code>SILVER</code>: A billable client account plan.</li>
+  * <li><code>BRONZE</code>: A billable client account plan.</li>
  * </ul>
  * @property int $plan_group_id Updates an existing client account billing plan group to a new billing plan group. If you don't know the `plan_group_id` to use, contact our API support team.
  * @property int $billing_day_of_month This property is required if a client account is not set up to use single billing. You can choose to enter a specific day of the month or accept the default value, which is the day on which the <code>plan_type</code> value changes from a <code>TRIAL</code> plan to a different <code>plan_type</code>. For trial accounts, the value defaults to null. You can only change the <code>billing_day_of_month</code> when changing the <code>plan_type</code> value from <code>TRIAL</code> to a different <code>plan_type</code>, otherwise the value you enter is ignored.

src/ConstantContact/Definition/PlanTiersObject.php

@@ -7,7 +7,7 @@
 /**
  * @property string $plan_type The billing plan that is associated with a client's Constant Contact account. The billing plan determines which Constant Contact product features that the client account can access. If you are not on the latest billing plan, contact the Constant Contact Partner Team. However, older billing plans and <code>plan_type</code> enum values will continue to be supported. <ul>
  * <li><code>TRIAL</code>: Provides limited product features for a non-billed account and the account has an expiration date.</li>
- * <li><code>BRONZE</code>: Billable plan that provides basic email and marketing tools.</li>
+ * <li><code>BRONZE</code>: Billable plan that provides basic email and marketing tools.</li>  
  * <li><code>SILVER</code>: Billable plan that provides all features available in the <code>BRONZE</code> plan, and adds some additional email campaign to features, such as contact segmentation and social media ads integration.</li>
  * <li><code>GOLD</code>: Billable plan that provides all available product features.</li> * </ul>
  * @property array<\PHPFUI\ConstantContact\Definition\TierObject> $current_tiers Lists the billing plan tiers that are currently associated with a client account.

src/ConstantContact/Definition/TrackingActivitySmsChannelDTO.php

@@ -8,12 +8,12 @@
  * @property string $country_code The ISO country code that is associated with SMS address.
  * @property string $state The SMS channel status:
  * <ul><li><code>N</code>: not_set<li>
- * <li><code>T</code>: temp_hold<li>
- * <li><code>P</code>: pending_confirmation<li>
- * <li><code>I</code>: implicit<li>
- * <li><code>E</code>: explicit<li>
- * <li><code>O</code>: unsubscribed<li>
- * <li><code>D</code>:deprecated<li></ul>
+  * <li><code>T</code>: temp_hold<li>
+  * <li><code>P</code>: pending_confirmation<li>
+  * <li><code>I</code>: implicit<li>
+  * <li><code>E</code>: explicit<li>
+  * <li><code>O</code>: unsubscribed<li>
+  * <li><code>D</code>:deprecated<li></ul>
  * @property string $formatted_international The formatted SMS number returned if the SMS <code>country_code</code> does not match the contacts <code>country_code</code>.
  * @property string $formatted_national The formatted SMS number returned if the SMS <code>country_code</code> matches the contacts <code>country_code</code>.
  */

src/ConstantContact/V3/Account/Emails.php

@@ -28,7 +28,7 @@ public function __construct(\PHPFUI\ConstantContact\Client $client)
 	 *
 	 *
 	 * @param string $confirm_status Use the `confirm_status` query parameter to search for account emails using the email status. Possible values are `CONFIRMED` or `UNCONFIRMED`. You can also abbreviate the values of this query parameter and use `C` or `U`.
-	 *
+
 	 * @param string $role_code Use the `role_code` query parameter to search for account emails that have a specific role. Each each email address in an account can have multiple roles or no role. Possible values are `CONTACT`, `BILLING`, `REPLY_TO`, `JOURNALING`, or `OTHER`. You can also abbreviate the value of this query parameter and use `C`,`B`,`R`,`J`, or `O`.
 	 * @param string $email_address Use the `email_address` query parameter to search for a specific account email address.
 	 */
@@ -58,21 +58,12 @@ public function get(?string $confirm_status = null, ?string $role_code = null, ?
 		return $this->doGet(['confirm_status' => $confirm_status, 'role_code' => $role_code, 'email_address' => $email_address, ]);
 		}
 
-	/**
-	 * @return array<\PHPFUI\ConstantContact\Definition\AccountEmails>
-	 */
-	public function getReturnSchema(?string $confirm_status = null, ?string $role_code = null, ?string $email_address = null) : array
+	public function getReturnSchema(?string $confirm_status = null, ?string $role_code = null, ?string $email_address = null) : \PHPFUI\ConstantContact\Definition\AccountEmails
 		{
-		$array = [];
-
-		foreach ($this->get($confirm_status, $role_code, $email_address) as $object)
-			{
-			$array[] = new \PHPFUI\ConstantContact\Definition\AccountEmails($object);
-			}
-
-		return $array;
+		return new \PHPFUI\ConstantContact\Definition\AccountEmails($this->get($confirm_status, $role_code, $email_address));
 		}
 
+
 	/**
 	 * POST Add an Account Email Address
 	 *
@@ -101,4 +92,5 @@ public function postReturnSchema(\PHPFUI\ConstantContact\Definition\AccountEmail
 		{
 		return new \PHPFUI\ConstantContact\Definition\AccountEmailCreateResponse($this->post($body));
 		}
+
 	}

src/ConstantContact/V3/Account/Summary.php

@@ -47,6 +47,7 @@ public function getReturnSchema(?string $extra_fields = null) : \PHPFUI\Constant
 		return new \PHPFUI\ConstantContact\Definition\Customer($this->get($extra_fields));
 		}
 
+
 	/**
 	 * PUT (update) Account Details
 	 *
@@ -69,4 +70,5 @@ public function putReturnSchema(\PHPFUI\ConstantContact\Definition\CustomerPut $
 		{
 		return new \PHPFUI\ConstantContact\Definition\CustomerPut($this->put($body));
 		}
+
 	}

src/ConstantContact/V3/Account/Summary/PhysicalAddress.php

@@ -31,6 +31,7 @@ public function getReturnSchema() : \PHPFUI\ConstantContact\Definition\AccountPh
 		return new \PHPFUI\ConstantContact\Definition\AccountPhysicalAddress($this->get());
 		}
 
+
 	/**
 	 * POST the Physical Address for the Account
 	 *
@@ -55,6 +56,7 @@ public function postReturnSchema(\PHPFUI\ConstantContact\Definition\AccountPhysi
 		return new \PHPFUI\ConstantContact\Definition\AccountPhysicalAddress($this->post($body));
 		}
 
+
 	/**
 	 * PUT (update) the Physical Address for an Account
 	 *
@@ -82,4 +84,5 @@ public function putReturnSchema(\PHPFUI\ConstantContact\Definition\AccountPhysic
 		{
 		return new \PHPFUI\ConstantContact\Definition\AccountPhysicalAddress($this->put($body));
 		}
+
 	}

src/ConstantContact/V3/Account/User/Privileges.php

@@ -28,18 +28,9 @@ public function get() : array
 		return $this->doGet([]);
 		}
 
-	/**
-	 * @return array<\PHPFUI\ConstantContact\Definition\UserPrivilegesResource>
-	 */
-	public function getReturnSchema() : array
+	public function getReturnSchema() : \PHPFUI\ConstantContact\Definition\UserPrivilegesResource
 		{
-		$array = [];
-
-		foreach ($this->get() as $object)
-			{
-			$array[] = new \PHPFUI\ConstantContact\Definition\UserPrivilegesResource($object);
-			}
-
-		return $array;
+		return new \PHPFUI\ConstantContact\Definition\UserPrivilegesResource($this->get());
 		}
+
 	}

src/ConstantContact/V3/Activities.php

@@ -43,4 +43,5 @@ public function getReturnSchema(?int $limit = null, ?string $state = null) : \PH
 		{
 		return new \PHPFUI\ConstantContact\Definition\Activities($this->get($limit, $state));
 		}
+
 	}

src/ConstantContact/V3/Activities/AddListMemberships.php

@@ -32,4 +32,5 @@ public function postReturnSchema(\PHPFUI\ConstantContact\Definition\ListActivity
 		{
 		return new \PHPFUI\ConstantContact\Definition\ActivityListsMembership($this->post($body));
 		}
+
 	}

src/ConstantContact/V3/Activities/ContactDelete.php

@@ -34,4 +34,5 @@ public function postReturnSchema(\PHPFUI\ConstantContact\Definition\ContactDelet
 		{
 		return new \PHPFUI\ConstantContact\Definition\ActivityDeleteStatus($this->post($body));
 		}
+
 	}

src/ConstantContact/V3/Activities/ContactExports.php

@@ -37,4 +37,5 @@ public function postReturnSchema(\PHPFUI\ConstantContact\Definition\ContactsExpo
 		{
 		return new \PHPFUI\ConstantContact\Definition\ActivityExportStatus($this->post($body));
 		}
+
 	}

src/ConstantContact/V3/Activities/ContactsFileImport.php

@@ -30,8 +30,8 @@ public function __construct(\PHPFUI\ConstantContact\Client $client)
 	 * and the remaining data is dropped.
 	 *
 	 * @param string $file The CSV file you are importing. The column headings that you can use in the file are: `first_name`, `last_name`, `email`, `phone`, `job_title`, `anniversary`, `birthday_day`, `birthday_month`, `company_name`, `street`, `street2`, `city`, `state`, `zip`, and `country`. The only required column heading is `email`.
-	 *
-	 * You can also use custom fields as column headings. Enter the custom field name prefixed with `cf:` as the column heading. For example, use `cf:first_name` as the header name if you have a custom field named "first_name". The custom field must already exist in the Constant Contact account you are using. Depending on the custom field data type, you can enter dates or strings as the value of the custom field. Each contact can contain up to 25 different custom fields.
+
+You can also use custom fields as column headings. Enter the custom field name prefixed with `cf:` as the column heading. For example, use `cf:first_name` as the header name if you have a custom field named "first_name". The custom field must already exist in the Constant Contact account you are using. Depending on the custom field data type, you can enter dates or strings as the value of the custom field. Each contact can contain up to 25 different custom fields.
 	 * @param array $list_ids Specify which contact lists you are adding all imported contacts to as an array of up to 50 contact `list_id` values.
 	 */
 	public function post(string $file, array $list_ids) : array
@@ -44,4 +44,5 @@ public function postReturnSchema(string $file, array $list_ids) : \PHPFUI\Consta
 		{
 		return new \PHPFUI\ConstantContact\Definition\ActivityImport($this->post($file, $list_ids));
 		}
+
 	}

src/ConstantContact/V3/Activities/ContactsJsonImport.php

@@ -49,4 +49,5 @@ public function postReturnSchema(\PHPFUI\ConstantContact\Definition\ContactsJson
 		{
 		return new \PHPFUI\ConstantContact\Definition\ActivityImport($this->post($body));
 		}
+
 	}

src/ConstantContact/V3/Activities/ContactsTaggingsAdd.php

@@ -37,4 +37,5 @@ public function postReturnSchema(\PHPFUI\ConstantContact\Definition\TagAddRemove
 		{
 		return new \PHPFUI\ConstantContact\Definition\ActivityTagging($this->post($body));
 		}
+
 	}

src/ConstantContact/V3/Activities/ContactsTaggingsRemove.php

@@ -37,4 +37,5 @@ public function postReturnSchema(\PHPFUI\ConstantContact\Definition\TagAddRemove
 		{
 		return new \PHPFUI\ConstantContact\Definition\ActivityTagging($this->post($body));
 		}
+
 	}

src/ConstantContact/V3/Activities/ContactsTagsDelete.php

@@ -31,4 +31,5 @@ public function postReturnSchema(\PHPFUI\ConstantContact\Definition\TagIdList500
 		{
 		return new \PHPFUI\ConstantContact\Definition\ActivityTagging($this->post($body));
 		}
+
 	}

src/ConstantContact/V3/Activities/CustomFieldsDelete.php

@@ -29,4 +29,5 @@ public function postReturnSchema(\PHPFUI\ConstantContact\Definition\CustomFieldI
 		{
 		return new \PHPFUI\ConstantContact\Definition\ActivityDeleteCustomFields($this->post($body));
 		}
+
 	}