V22.6.0 - 2022-06-02

Author: phpfui

src/ConstantContact/Definition/ABTestData.php

@@ -5,9 +5,9 @@
 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.
+ * @property string $alternative_subject The alternate email subject line to use for A/B testing.
+ * @property 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.
+ * @property 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. Valid values include <code>6</code>, <code>12</code>, <code>24</code>, and <code>48</code>. 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
 	{

src/ConstantContact/Definition/AccountCancellation.php

@@ -5,7 +5,7 @@
 namespace PHPFUI\ConstantContact\Definition;
 
 /**
- * @var int $reason_id Specifies the reason that the client is canceling their Constant Contact account as follows:
+ * @property int $reason_id Specifies the reason that the client is canceling their Constant Contact account as follows:
  * <ul>
  * <li><code>1</code>  Cost Too High</li>
  * <li><code>2</code>  Using A Competitive Service</li>
@@ -17,7 +17,7 @@
  * <li><code>27</code> Canceled Online by Customer</li>
  * <li><code>30</code> Dissatisfied With Billing Policies</li>
  * </ul>
- * @var \PHPFUI\ConstantContact\DateTime $effective_date The client account cancellation date and time in ISO-8601 format.
+ * @property \PHPFUI\ConstantContact\DateTime $effective_date The client account cancellation date and time in ISO-8601 format.
  */
 class AccountCancellation extends \PHPFUI\ConstantContact\Definition\Base
 	{

src/ConstantContact/Definition/AccountEmailCreateResponse.php

@@ -5,9 +5,9 @@
 namespace PHPFUI\ConstantContact\Definition;
 
 /**
- * @var string $email_address An email address associated with a Constant Contact account owner.
- * @var int $email_id The unique ID for an email address in a Constant Contact account.
- * @var string $confirm_status The confirmation status of the account email address. When you add a new email address to an account, Constant Contact automatically sends an email to that address with a link to confirm it. You can use any account email address with a <code>CONFIRMED</code> status to create an email campaign.
+ * @property string $email_address An email address associated with a Constant Contact account owner.
+ * @property int $email_id The unique ID for an email address in a Constant Contact account.
+ * @property string $confirm_status The confirmation status of the account email address. When you add a new email address to an account, Constant Contact automatically sends an email to that address with a link to confirm it. You can use any account email address with a <code>CONFIRMED</code> status to create an email campaign.
  */
 class AccountEmailCreateResponse extends \PHPFUI\ConstantContact\Definition\Base
 	{

src/ConstantContact/Definition/AccountEmailInput.php

@@ -5,7 +5,7 @@
 namespace PHPFUI\ConstantContact\Definition;
 
 /**
- * @var string $email_address The new email address you want to add to a Constant Contact account.
+ * @property string $email_address The new email address you want to add to a Constant Contact account.
  */
 class AccountEmailInput extends \PHPFUI\ConstantContact\Definition\Base
 	{

src/ConstantContact/Definition/AccountPhysicalAddress.php

@@ -5,14 +5,14 @@
 namespace PHPFUI\ConstantContact\Definition;
 
 /**
- * @var string $address_line1 Line 1 of the organization's street address.
- * @var string $address_line2 Line 2 of the organization's street address.
- * @var string $address_line3 Line 3 of the organization's street address.
- * @var string $city The city where the organization is located.
- * @var string $state_code The two letter ISO 3166-1 code for the organization's state and only used if the <code>country_code</code> is <code>US</code> or <code>CA</code>. If not, exclude this property from the request body.
- * @var string $state_name Use if the state where the organization is physically located is not in the United States or Canada. If  <code>country_code</code> is  <code>US</code> or <code>CA</code>, exclude this property from the request body.
- * @var string $postal_code The postal code address (ZIP code) of the organization. This property is required if the <code>state_code</code> is <code>US</code> or <code>CA</code>, otherwise exclude this property from the request body.
- * @var string $country_code The two letter <a href='https://en.wikipedia.org/wiki/ISO_3166-1' target='_blank'>ISO 3166-1 code</a> for the organization's country.
+ * @property string $address_line1 Line 1 of the organization's street address.
+ * @property string $address_line2 Line 2 of the organization's street address.
+ * @property string $address_line3 Line 3 of the organization's street address.
+ * @property string $city The city where the organization is located.
+ * @property string $state_code The two letter ISO 3166-1 code for the organization's state and only used if the <code>country_code</code> is <code>US</code> or <code>CA</code>. If not, exclude this property from the request body.
+ * @property string $state_name Use if the state where the organization is physically located is not in the United States or Canada. If  <code>country_code</code> is  <code>US</code> or <code>CA</code>, exclude this property from the request body.
+ * @property string $postal_code The postal code address (ZIP code) of the organization. This property is required if the <code>state_code</code> is <code>US</code> or <code>CA</code>, otherwise exclude this property from the request body.
+ * @property string $country_code The two letter <a href='https://en.wikipedia.org/wiki/ISO_3166-1' target='_blank'>ISO 3166-1 code</a> for the organization's country.
  */
 class AccountPhysicalAddress extends \PHPFUI\ConstantContact\Definition\Base
 	{

src/ConstantContact/Definition/Activities.php

@@ -5,8 +5,8 @@
 namespace PHPFUI\ConstantContact\Definition;
 
 /**
- * @var array $activities A list of bulk activity jobs and status submitted by the account over the past 10 days.
- * @var \PHPFUI\ConstantContact\Definition\PagingLinks $_links
+ * @property array $activities A list of bulk activity jobs and status submitted by the account over the past 10 days.
+ * @property \PHPFUI\ConstantContact\Definition\PagingLinks $_links
  */
 class Activities extends \PHPFUI\ConstantContact\Definition\Base
 	{

src/ConstantContact/Definition/Activity.php

@@ -5,17 +5,17 @@
 namespace PHPFUI\ConstantContact\Definition;
 
 /**
- * @var \PHPFUI\ConstantContact\UUID $activity_id Unique ID for the activity.
- * @var string $state The state of the request: initialized - request has been received processing - request is being processed completed - job completed cancelled - request was cancelled failed - job failed to complete timed_out - the request timed out before completing
- * @var \PHPFUI\ConstantContact\DateTime $started_at Timestamp showing when we began processing the activity request, in ISO-8601 format.
- * @var \PHPFUI\ConstantContact\DateTime $completed_at Timestamp showing when we completed processing the activity, in ISO-8601 format.
- * @var \PHPFUI\ConstantContact\DateTime $created_at Timestamp showing when we created the activity, in ISO-8601 format.
- * @var \PHPFUI\ConstantContact\DateTime $updated_at Timestamp showing when we last updated the activity, in ISO-8601 format.
- * @var string $source_file_name Name of the file used for an add_contacts activity.
- * @var int $percent_done Shows the percent done for an activity that we are still processing.
- * @var array $activity_errors Array of messages describing the errors that occurred.
- * @var \PHPFUI\ConstantContact\Definition\ActivityStatus $status
- * @var \PHPFUI\ConstantContact\Definition\ActivityStatusExportLink $_links
+ * @property \PHPFUI\ConstantContact\UUID $activity_id Unique ID for the activity.
+ * @property string $state The state of the request: initialized - request has been received processing - request is being processed completed - job completed cancelled - request was cancelled failed - job failed to complete timed_out - the request timed out before completing
+ * @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.
+ * @property \PHPFUI\ConstantContact\DateTime $updated_at Timestamp showing when we last updated the activity, in ISO-8601 format.
+ * @property string $source_file_name Name of the file used for an add_contacts activity.
+ * @property int $percent_done Shows the percent done for an activity that we are still processing.
+ * @property array $activity_errors Array of messages describing the errors that occurred.
+ * @property \PHPFUI\ConstantContact\Definition\ActivityStatus $status
+ * @property \PHPFUI\ConstantContact\Definition\ActivityStatusExportLink $_links
  */
 class Activity extends \PHPFUI\ConstantContact\Definition\Base
 	{

src/ConstantContact/Definition/ActivityDeleteListResponse.php

@@ -5,13 +5,13 @@
 namespace PHPFUI\ConstantContact\Definition;
 
 /**
- * @var \PHPFUI\ConstantContact\UUID $activity_id Unique ID for the delete list batch job
- * @var string $state The state of the delete list request: processing - request is being processed completed - job completed cancelled - request was cancelled failed - job failed to complete timed_out - the request timed out before completing
- * @var \PHPFUI\ConstantContact\DateTime $created_at Date and time that the request was received, in ISO-8601 formmat.
- * @var \PHPFUI\ConstantContact\DateTime $updated_at Date and time that the request status was updated, in ISO-8601 format.
- * @var int $percent_done Job completion percentage
- * @var array $activity_errors Array of messages describing the errors that occurred.
- * @var \PHPFUI\ConstantContact\Definition\Link $_links
+ * @property \PHPFUI\ConstantContact\UUID $activity_id Unique ID for the delete list batch job
+ * @property string $state The state of the delete list request: processing - request is being processed completed - job completed cancelled - request was cancelled failed - job failed to complete timed_out - the request timed out before completing
+ * @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.
+ * @property int $percent_done Job completion percentage
+ * @property array $activity_errors Array of messages describing the errors that occurred.
+ * @property \PHPFUI\ConstantContact\Definition\Link $_links
  */
 class ActivityDeleteListResponse extends \PHPFUI\ConstantContact\Definition\Base
 	{

src/ConstantContact/Definition/ActivityDeleteStatus.php

@@ -5,16 +5,16 @@
 namespace PHPFUI\ConstantContact\Definition;
 
 /**
- * @var \PHPFUI\ConstantContact\UUID $activity_id Unique ID for the activity.
- * @var string $state The state of the request: initialized - request has been received processing - request is being processed completed - job completed cancelled - request was cancelled failed - job failed to complete timed_out - the request timed out before completing
- * @var \PHPFUI\ConstantContact\DateTime $started_at Timestamp showing when we began processing the activity request, in ISO-8601 format.
- * @var \PHPFUI\ConstantContact\DateTime $completed_at Timestamp showing when we completed processing the activity, in ISO-8601 format.
- * @var \PHPFUI\ConstantContact\DateTime $created_at Timestamp showing when we created the activity, in ISO-8601 format.
- * @var \PHPFUI\ConstantContact\DateTime $updated_at Timestamp showing when we last updated the activity, in ISO-8601 format.
- * @var int $percent_done Shows the percent done for an activity that we are still processing.
- * @var array $activity_errors Array of messages describing the errors that occurred.
- * @var \PHPFUI\ConstantContact\Definition\Status $status
- * @var \PHPFUI\ConstantContact\Definition\Link $_links
+ * @property \PHPFUI\ConstantContact\UUID $activity_id Unique ID for the activity.
+ * @property string $state The state of the request: initialized - request has been received processing - request is being processed completed - job completed cancelled - request was cancelled failed - job failed to complete timed_out - the request timed out before completing
+ * @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.
+ * @property \PHPFUI\ConstantContact\DateTime $updated_at Timestamp showing when we last updated the activity, in ISO-8601 format.
+ * @property int $percent_done Shows the percent done for an activity that we are still processing.
+ * @property array $activity_errors Array of messages describing the errors that occurred.
+ * @property \PHPFUI\ConstantContact\Definition\Status $status
+ * @property \PHPFUI\ConstantContact\Definition\Link $_links
  */
 class ActivityDeleteStatus extends \PHPFUI\ConstantContact\Definition\Base
 	{

src/ConstantContact/Definition/ActivityErrors.php

@@ -5,7 +5,7 @@
 namespace PHPFUI\ConstantContact\Definition;
 
 /**
- * @var string $message Message describing the error condition.
+ * @property string $message Message describing the error condition.
  */
 class ActivityErrors extends \PHPFUI\ConstantContact\Definition\Base
 	{

src/ConstantContact/Definition/ActivityExportStatus.php

@@ -5,16 +5,16 @@
 namespace PHPFUI\ConstantContact\Definition;
 
 /**
- * @var \PHPFUI\ConstantContact\UUID $activity_id Unique ID for the activity.
- * @var string $state The state of the request: initialized - request has been received processing - request is being processed completed - job completed cancelled - request was cancelled failed - job failed to complete timed_out - the request timed out before completing
- * @var \PHPFUI\ConstantContact\DateTime $started_at Timestamp showing when we began processing the activity request, in ISO-8601 format.
- * @var \PHPFUI\ConstantContact\DateTime $completed_at Timestamp showing when we completed processing the activity, in ISO-8601 format.
- * @var \PHPFUI\ConstantContact\DateTime $created_at Timestamp showing when we created the activity, in ISO-8601 format.
- * @var \PHPFUI\ConstantContact\DateTime $updated_at Timestamp showing when we last updated the activity, in ISO-8601 format.
- * @var int $percent_done Shows the percent done for an activity that we are still processing.
- * @var array $activity_errors Array of messages describing the errors that occurred.
- * @var \PHPFUI\ConstantContact\Definition\Status $status
- * @var \PHPFUI\ConstantContact\Definition\ActivityStatusExportLink $_links
+ * @property \PHPFUI\ConstantContact\UUID $activity_id Unique ID for the activity.
+ * @property string $state The state of the request: initialized - request has been received processing - request is being processed completed - job completed cancelled - request was cancelled failed - job failed to complete timed_out - the request timed out before completing
+ * @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.
+ * @property \PHPFUI\ConstantContact\DateTime $updated_at Timestamp showing when we last updated the activity, in ISO-8601 format.
+ * @property int $percent_done Shows the percent done for an activity that we are still processing.
+ * @property array $activity_errors Array of messages describing the errors that occurred.
+ * @property \PHPFUI\ConstantContact\Definition\Status $status
+ * @property \PHPFUI\ConstantContact\Definition\ActivityStatusExportLink $_links
  */
 class ActivityExportStatus extends \PHPFUI\ConstantContact\Definition\Base
 	{

src/ConstantContact/Definition/ActivityGeneric.php

@@ -5,14 +5,14 @@
 namespace PHPFUI\ConstantContact\Definition;
 
 /**
- * @var string $activity_id The ID that uniquely identifies the activity.
- * @var string $state The processing state for the activity.
- * @var \PHPFUI\ConstantContact\DateTime $created_at The system generated date and time that the resource was created, in ISO-8601 format.
- * @var \PHPFUI\ConstantContact\DateTime $updated_at The system generated date and time that the resource was last updated, in ISO-8601 format.
- * @var int $percent_done The percentage complete for the specified activity.
- * @var array<\PHPFUI\ConstantContact\Definition\ActivityErrors> $activity_errors An array of error messages if errors occurred for a specified activity. The system returns an empty array if no errors occur.
- * @var \PHPFUI\ConstantContact\Definition\ActivityGenericStatus $status
- * @var \PHPFUI\ConstantContact\Definition\ActivityLinks2 $_links
+ * @property string $activity_id The ID that uniquely identifies the activity.
+ * @property string $state The processing state for the activity.
+ * @property \PHPFUI\ConstantContact\DateTime $created_at The system generated date and time that the resource was created, in ISO-8601 format.
+ * @property \PHPFUI\ConstantContact\DateTime $updated_at The system generated date and time that the resource was last updated, in ISO-8601 format.
+ * @property int $percent_done The percentage complete for the specified activity.
+ * @property array<\PHPFUI\ConstantContact\Definition\ActivityErrors> $activity_errors An array of error messages if errors occurred for a specified activity. The system returns an empty array if no errors occur.
+ * @property \PHPFUI\ConstantContact\Definition\ActivityGenericStatus $status
+ * @property \PHPFUI\ConstantContact\Definition\ActivityLinks2 $_links
  */
 class ActivityGeneric extends \PHPFUI\ConstantContact\Definition\Base
 	{

src/ConstantContact/Definition/ActivityGenericStatus.php

@@ -5,8 +5,8 @@
 namespace PHPFUI\ConstantContact\Definition;
 
 /**
- * @var int $items_total_count The total number of tags that this activity will delete.
- * @var int $items_completed_count The number of tags that this activity has currently deleted.
+ * @property int $items_total_count The total number of tags that this activity will delete.
+ * @property int $items_completed_count The number of tags that this activity has currently deleted.
  */
 class ActivityGenericStatus extends \PHPFUI\ConstantContact\Definition\Base
 	{