V23.4.0 - 2023-04-05

Author: phpfui

src/ConstantContact/Definition/ActivityDeleteListsResponse.php

@@ -0,0 +1,34 @@
+<?php
+
+// Generated file. Do not edit by hand. Use update.php in project root.
+
+namespace PHPFUI\ConstantContact\Definition;
+
+/**
+ * @property string $activity_id The system assigned UUID that uniquely identifies an activity.
+ * @property string $state The activity processing state.
+ * @property \PHPFUI\ConstantContact\DateTime $started_at Timestamp showing when processing started for the activity, in ISO-8601 format.
+ * @property \PHPFUI\ConstantContact\DateTime $completed_at Timestamp showing when processing completed for the activity, in ISO-8601 format.
+ * @property \PHPFUI\ConstantContact\DateTime $created_at Timestamp showing when the activity was first requested, in ISO-8601 format.
+ * @property \PHPFUI\ConstantContact\DateTime $updated_at Timestamp showing when the activity was last updated, in ISO-8601 format.
+ * @property int $percent_done The processing percent complete for the activity.
+ * @property array $activity_errors An array of error message strings describing the errors that occurred.
+ * @property \PHPFUI\ConstantContact\Definition\Status $status
+ * @property \PHPFUI\ConstantContact\Definition\Link $_links
+ */
+class ActivityDeleteListsResponse extends \PHPFUI\ConstantContact\Definition\Base
+	{
+	protected static array $fields = [
+		'activity_id' => 'string',
+		'state' => ['initialized', 'processing', 'completed', 'cancelled', 'failed', 'timed_out'],
+		'started_at' => '\PHPFUI\ConstantContact\DateTime',
+		'completed_at' => '\PHPFUI\ConstantContact\DateTime',
+		'created_at' => '\PHPFUI\ConstantContact\DateTime',
+		'updated_at' => '\PHPFUI\ConstantContact\DateTime',
+		'percent_done' => 'int',
+		'activity_errors' => 'array',
+		'status' => '\PHPFUI\ConstantContact\Definition\Status',
+		'_links' => '\PHPFUI\ConstantContact\Definition\Link',
+
+	];
+	}

src/ConstantContact/Definition/ContactList.php

@@ -12,7 +12,7 @@
  * @property \PHPFUI\ConstantContact\DateTime $created_at System generated date and time that the resource was created, in ISO-8601 format.
  * @property \PHPFUI\ConstantContact\DateTime $updated_at Date and time that the list was last updated, in ISO-8601 format. System generated.
  * @property \PHPFUI\ConstantContact\DateTime $deleted_at If the list was deleted, this property shows the date and time it was deleted, in ISO-8601 format. System generated.
- * @property int $membership_count The number of contacts in the contact list.
+ * @property int $membership_count The total number of contacts that are members in a list. Does not apply to segment type lists.
  */
 class ContactList extends \PHPFUI\ConstantContact\Definition\Base
 	{

src/ConstantContact/Definition/ContactListPutPost.php

@@ -0,0 +1,28 @@
+<?php
+
+// Generated file. Do not edit by hand. Use update.php in project root.
+
+namespace PHPFUI\ConstantContact\Definition;
+
+/**
+ * @property \PHPFUI\ConstantContact\UUID $list_id Unique ID for the contact list
+ * @property string $name The name given to the contact list
+ * @property string $description Text describing the list.
+ * @property bool $favorite Identifies whether or not the account has favorited the contact list.
+ * @property \PHPFUI\ConstantContact\DateTime $created_at System generated date and time that the resource was created, in ISO-8601 format.
+ * @property \PHPFUI\ConstantContact\DateTime $updated_at Date and time that the list was last updated, in ISO-8601 format. System generated.
+ * @property \PHPFUI\ConstantContact\DateTime $deleted_at If the list was deleted, this property shows the date and time it was deleted, in ISO-8601 format. System generated.
+ */
+class ContactListPutPost extends \PHPFUI\ConstantContact\Definition\Base
+	{
+	protected static array $fields = [
+		'list_id' => '\PHPFUI\ConstantContact\UUID',
+		'name' => 'string',
+		'description' => 'string',
+		'favorite' => 'bool',
+		'created_at' => '\PHPFUI\ConstantContact\DateTime',
+		'updated_at' => '\PHPFUI\ConstantContact\DateTime',
+		'deleted_at' => '\PHPFUI\ConstantContact\DateTime',
+
+	];
+	}

src/ConstantContact/Definition/ContactPostRequest.php

@@ -17,7 +17,7 @@
  * @property array<\PHPFUI\ConstantContact\Definition\ContactCustomField> $custom_fields Array of up to 25 <code>custom_field</code> key value pairs.
  * @property array<\PHPFUI\ConstantContact\Definition\PhoneNumberPut> $phone_numbers Array of up to 3 phone numbers subresources.
  * @property array<\PHPFUI\ConstantContact\Definition\StreetAddressPut> $street_addresses Array of up to 3 street address subresources.
- * @property array<\PHPFUI\ConstantContact\UUID> $list_memberships Array of <code>list_id<code>s to which the contact is being subscribed, up to a maximum of 50.
+ * @property array<\PHPFUI\ConstantContact\UUID> $list_memberships Array of <code>list_id</code>s to which the contact is being subscribed, up to a maximum of 50.
  * @property array<\PHPFUI\ConstantContact\UUID> $taggings Array of tags (<code>tag_id</code>) assigned to the contact, up to a maximum of 50.
  * @property array<\PHPFUI\ConstantContact\Definition\Note> $notes An array of notes about the contact.
  */

src/ConstantContact/Definition/ListIdList100.php

@@ -0,0 +1,21 @@
+<?php
+
+// Generated file. Do not edit by hand. Use update.php in project root.
+
+namespace PHPFUI\ConstantContact\Definition;
+
+/**
+ * @property array<\PHPFUI\ConstantContact\UUID> $list_ids The array of contact lists <code>list_id</code> to delete.
+ */
+class ListIdList100 extends \PHPFUI\ConstantContact\Definition\Base
+	{
+	protected static array $fields = [
+		'list_ids' => 'array<\PHPFUI\ConstantContact\UUID>',
+
+	];
+
+	protected static array $maxLength = [
+		'list_ids' => 100,
+
+	];
+	}

src/ConstantContact/Definition/Status.php

@@ -5,15 +5,11 @@
 namespace PHPFUI\ConstantContact\Definition;
 
 /**
- * @property int $items_total_count Total number of contacts to add to or remove from lists.
- * @property int $items_completed_count The number of contacts processed.
- * @property int $list_count The number of lists specified in the request.
+ * @property int $list_count The number of lists deleted.
  */
 class Status extends \PHPFUI\ConstantContact\Definition\Base
 	{
 	protected static array $fields = [
-		'items_total_count' => 'int',
-		'items_completed_count' => 'int',
 		'list_count' => 'int',
 
 	];

src/ConstantContact/V3/Activities/ListDelete.php

@@ -0,0 +1,26 @@
+<?php
+
+// Generated file. Do not edit by hand. Use update.php in project root.
+
+namespace PHPFUI\ConstantContact\V3\Activities;
+
+class ListDelete extends \PHPFUI\ConstantContact\Base
+	{
+	public function __construct(\PHPFUI\ConstantContact\Client $client)
+		{
+		parent::__construct($client, '/v3/activities/list_delete');
+		}
+
+	/**
+	 * Delete Contact Lists
+	 *
+	 * Use this endpoint to delete up to 100 contact lists in an account.
+	 *
+	 * @param \PHPFUI\ConstantContact\Definition\ListIdList100 $body An array of `list_id`'s to delete.
+	 */
+	public function post(\PHPFUI\ConstantContact\Definition\ListIdList100 $body) : array
+		{
+
+		return $this->doPost(['body' => $body->getData(), ]);
+		}
+	}

src/ConstantContact/V3/ContactList.php

@@ -18,7 +18,7 @@ public function __construct(\PHPFUI\ConstantContact\Client $client)
 	 *
 	 *
 	 * @param string $list_id The system generated ID that uniquely identifies a contact list.
-	 * @param string $include_membership_count Use to include the number of contact members per list by setting the `include_membership_count` to either `active`, to count only active contacts, or `all` to include all contacts in the count.
+	 * @param string $include_membership_count Returns the total number of contacts per list that meet your selection criteria. Set the `include_membership_count` to `active`, to count only active contacts, or `all` to include all contacts in the count.
 	 */
 	public function get(string $list_id, ?string $include_membership_count = null) : array
 		{

src/ConstantContact/V3/ContactLists.php

@@ -22,7 +22,7 @@ public function __construct(\PHPFUI\ConstantContact\Client $client)
 	 *
 	 * @param int $limit Use to specify the number of results displayed per page of output, from 1 - 500, default = 50.
 	 * @param bool $include_count Set `include_count` to `true` to return the total number of contact lists that meet your selection criteria.
-	 * @param string $include_membership_count Use to include the total number of contacts members in each list. Set to  `active`, to count only active (mailable) contacts, or `all` to count all contacts.
+	 * @param string $include_membership_count Use to include the total number of contacts per list. Set to  `active`, to count only active (mailable) contacts, or `all` to count all contacts.
 	 * @param string $name Use to get details for a single list by entering the full name of the list.
 	 * @param string $status Use to get lists by status. Accepts comma-separated status values.
 	 */