V25.2.0 - 2025-02-15

Author: phpfui

src/ConstantContact/Definition/ActivityDeleteListResponse.php

@@ -15,7 +15,7 @@
  <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 $created_at Date and time that the request was received, in ISO-8601 format.
  * @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.

src/ConstantContact/Definition/ContactCreateOrUpdateInput.php

@@ -17,6 +17,7 @@
  * @property int $birthday_month The month value for the contact's birthday. Valid values are from 1 through 12. The <code>birthday_month</code> property is required if you use <code>birthday_day</code>.
  * @property int $birthday_day The day value for the contact's birthday. Valid values are from 1 through 31. The <code>birthday_day</code> property is required if you use <code>birthday_month</code>.
  * @property \PHPFUI\ConstantContact\Definition\StreetAddress $street_address
+ * @property string $sms_channel The contact's SMS compatible phone number.
  */
 class ContactCreateOrUpdateInput extends \PHPFUI\ConstantContact\Definition\Base
 	{
@@ -33,6 +34,7 @@ class ContactCreateOrUpdateInput extends \PHPFUI\ConstantContact\Definition\Base
 		'birthday_month' => 'int',
 		'birthday_day' => 'int',
 		'street_address' => '\PHPFUI\ConstantContact\Definition\StreetAddress',
+		'sms_channel' => 'string',
 
 	];
 

src/ConstantContact/Definition/ContactPostRequest.php

@@ -20,6 +20,7 @@
  * @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.
+ * @property \PHPFUI\ConstantContact\Definition\ContactSmsChannel $sms_channel
  */
 class ContactPostRequest extends \PHPFUI\ConstantContact\Definition\Base
 	{
@@ -39,6 +40,7 @@ class ContactPostRequest extends \PHPFUI\ConstantContact\Definition\Base
 		'list_memberships' => 'array<\PHPFUI\ConstantContact\UUID>',
 		'taggings' => 'array<\PHPFUI\ConstantContact\UUID>',
 		'notes' => 'array<\PHPFUI\ConstantContact\Definition\Note>',
+		'sms_channel' => '\PHPFUI\ConstantContact\Definition\ContactSmsChannel',
 
 	];
 

src/ConstantContact/Definition/ContactPutRequest.php

@@ -20,6 +20,7 @@
  * @property array<\PHPFUI\ConstantContact\UUID> $list_memberships Array of up to 50 <code>list_ids</code> to which the contact is subscribed.
  * @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 listed by most recent note first.
+ * @property \PHPFUI\ConstantContact\Definition\ContactSmsChannel $sms_channel
  */
 class ContactPutRequest extends \PHPFUI\ConstantContact\Definition\Base
 	{
@@ -39,6 +40,7 @@ class ContactPutRequest extends \PHPFUI\ConstantContact\Definition\Base
 		'list_memberships' => 'array<\PHPFUI\ConstantContact\UUID>',
 		'taggings' => 'array<\PHPFUI\ConstantContact\UUID>',
 		'notes' => 'array<\PHPFUI\ConstantContact\Definition\Note>',
+		'sms_channel' => '\PHPFUI\ConstantContact\Definition\ContactSmsChannel',
 
 	];
 

src/ConstantContact/Definition/ContactResubscribeRequest.php

@@ -0,0 +1,16 @@
+<?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 Array of list id values. Constant Contact adds the resubscribed contact to the contact lists you provide in the array.
+ */
+class ContactResubscribeRequest extends \PHPFUI\ConstantContact\Definition\Base
+	{
+	protected static array $fields = [
+		'list_ids' => 'array<\PHPFUI\ConstantContact\UUID>',
+
+	];
+	}

src/ConstantContact/Definition/ContactSmsChannel.php

@@ -0,0 +1,18 @@
+<?php
+
+// Generated file. Do not edit by hand. Use update.php in project root.
+
+namespace PHPFUI\ConstantContact\Definition;
+
+/**
+ * @property string $full_sms_address The SMS-capable phone number for the Contact, including the dial code
+ * @property array<\PHPFUI\ConstantContact\Definition\ContactSmsChannelConsents> $sms_channel_consents The consents for the SMS Channel.
+ */
+class ContactSmsChannel extends \PHPFUI\ConstantContact\Definition\Base
+	{
+	protected static array $fields = [
+		'full_sms_address' => 'string',
+		'sms_channel_consents' => 'array<\PHPFUI\ConstantContact\Definition\ContactSmsChannelConsents>',
+
+	];
+	}

src/ConstantContact/Definition/ContactSmsChannelConsents.php

@@ -0,0 +1,20 @@
+<?php
+
+// Generated file. Do not edit by hand. Use update.php in project root.
+
+namespace PHPFUI\ConstantContact\Definition;
+
+/**
+ * @property string $sms_consent_permission The current status of the SMS channel.
+ * @property string $consent_type The type of consent provided.
+ * @property string $consent_medium_details Additional information about the consent such as the type of device used.
+ */
+class ContactSmsChannelConsents extends \PHPFUI\ConstantContact\Definition\Base
+	{
+	protected static array $fields = [
+		'sms_consent_permission' => 'string',
+		'consent_type' => 'string',
+		'consent_medium_details' => 'string',
+
+	];
+	}

src/ConstantContact/Definition/HistoryDetails.php

@@ -12,7 +12,6 @@
  * @property string $consent_action_type The type of consent action provided.
  * @property string $consent_medium_type The code representing the medium used to provide consent. Medium types include mobile device (<code>MD</code>). lead generation form(<code>LF</code>), deactivation by carrier(<code>CD</code>), import_file:(<code>FI</code>), and system (<code>SY</code>).
  * @property string $source_consent_timestamp The time that SMS consent was last updated.
- * @property string $source_ip If applicable, the IP address from which the consent came.
  * @property string $source_sms_number If applicable, the SMS consent number associated with the source.
  * @property int $advertised_frequency If applicable, the advertising numeric component used to advertise to the contact.. For example, if <code>advertised_frequency</code> is set to <code> 2</code> , and  <code>advertised_interval</code> is set to <code>M</code>, the contact receives advertisements twice a month.
  * @property string $advertised_interval If applicable, the interval component used to advertise to the contact. For example, if <code>advertised_frequency</code> is set to <code> 2</code> , and  <code>advertised_interval</code> is set to <code>M</code>, the contact receives advertisements twice a month.
@@ -27,7 +26,6 @@ class HistoryDetails extends \PHPFUI\ConstantContact\Definition\Base
 		'consent_action_type' => 'string',
 		'consent_medium_type' => 'string',
 		'source_consent_timestamp' => 'string',
-		'source_ip' => 'string',
 		'source_sms_number' => 'string',
 		'advertised_frequency' => 'int',
 		'advertised_interval' => 'string',

src/ConstantContact/Definition/JmmlSmsChannel.php

@@ -0,0 +1,22 @@
+<?php
+
+// Generated file. Do not edit by hand. Use update.php in project root.
+
+namespace PHPFUI\ConstantContact\Definition;
+
+/**
+ * @property string $sms_address The contact's SMS-capable phone number, excluding the country code.
+ * @property string $dial_code The dial code the country uses. For example, use <code>1</code> for the United States dial code.
+ * @property string $country_code The two-digit code that identifies the country.
+ * @property array<\PHPFUI\ConstantContact\Definition\JmmlSmsChannelConsents> $sms_channel_consents The consents provided for the SMS Channel.
+ */
+class JmmlSmsChannel extends \PHPFUI\ConstantContact\Definition\Base
+	{
+	protected static array $fields = [
+		'sms_address' => 'string',
+		'dial_code' => 'string',
+		'country_code' => 'string',
+		'sms_channel_consents' => 'array<\PHPFUI\ConstantContact\Definition\JmmlSmsChannelConsents>',
+
+	];
+	}

src/ConstantContact/Definition/JmmlSmsChannelConsents.php

@@ -0,0 +1,28 @@
+<?php
+
+// Generated file. Do not edit by hand. Use update.php in project root.
+
+namespace PHPFUI\ConstantContact\Definition;
+
+/**
+ * @property string $sms_consent_permission The current consent status of the SMS Channel.
+ * @property string $consent_type The type of consent provided.
+ * @property string $consent_medium_type A code representing where the consent was retrieved.
+ * @property string $consent_medium_url The URL for which the consent was gathered, such as a landing page.
+ * @property string $consent_medium_details Additional information for the consent
+ * @property int $advertised_frequency The numeric component used to indicate how often to send advertising. For example, <code>1</code> indicates once. Use with <code>advertised_internal</code> property to indicate when on the calender to send it. For example, to send once (<code>1</code>) daily, weekly, or monthly.
+ * @property string $advertised_interval The calender interval used to indicate when advertising is sent. For example <code>weekly</code>.
+ */
+class JmmlSmsChannelConsents extends \PHPFUI\ConstantContact\Definition\Base
+	{
+	protected static array $fields = [
+		'sms_consent_permission' => 'string',
+		'consent_type' => 'string',
+		'consent_medium_type' => 'string',
+		'consent_medium_url' => 'string',
+		'consent_medium_details' => 'string',
+		'advertised_frequency' => 'int',
+		'advertised_interval' => 'string',
+
+	];
+	}

src/ConstantContact/Definition/JsonImportContact.php

@@ -5,7 +5,7 @@
 namespace PHPFUI\ConstantContact\Definition;
 
 /**
- * @property string $email The email address of the contact. This method identifies each unique contact using their email address.
+ * @property string $email The email address of the contact. This method identifies each unique contact using their email address. Required if `sms_number` is not specified.
  * @property string $first_name The first name of the contact.
  * @property string $last_name The last name of the contact.
  * @property string $job_title The job title of the contact.
@@ -43,8 +43,8 @@
  * @property string $other_zip The zip or postal code associated with the contact's other address.
  * @property string $other_country The name of another country where the contact is located.
  * @property string $cf:custom_field_name The name of this property is dynamic based on the custom fields you want to import. Use a key-value pair where the key is an existing custom field name prefixed with <code>cf:</code>, and the value is a custom field string value. For example, if you have a custom field named <code>first_name</code> you can use <code>"cf:first_name":"Joe"</code>. Each contact can contain up to 25 different custom fields.
- * @property string $sms_number The US phone number to associate with the contact's SMS-enabled phone. The country code must be valid. Valid formats are <code>1231231234</code> or <code>123-123-1234</code>.
- * @property string $sms_consent_date Required if the SMS permission is set to `explict`. The date that the contact consented to receiving SMS messages. Valid date formats are MM/DD/YYYY, M/D/YYYY, YYYY/MM/DD, YYYY/M/D, YYYY-MM-DD, YYYY-M-D,M-D-YYYY, or M-DD-YYYY .
+ * @property string $sms_number The US phone number to associate with the contact's SMS-enabled phone. The country code must be valid. Valid formats are <code>1231231234</code> or <code>123-123-1234</code>. Required if `email` is not specified.
+ * @property string $sms_consent_date Required if the SMS permission is set to `explicit`. The date that the contact consented to receiving SMS messages. Valid date formats are MM/DD/YYYY, M/D/YYYY, YYYY/MM/DD, YYYY/M/D, YYYY-MM-DD, YYYY-M-D,M-D-YYYY, or M-DD-YYYY.
  */
 class JsonImportContact extends \PHPFUI\ConstantContact\Definition\Base
 	{

src/ConstantContact/V3/Activities/ContactsFileImport.php

@@ -18,31 +18,52 @@ public function __construct(\PHPFUI\ConstantContact\Client $client)
 	 * or updates contacts by importing a CSV file containing contact information.
 	 * Do not use a Content-Type header value with this method.
 	 *
-	 * Importing a new contact automatically sets the contact's `permission_to_send`
-	 * property as `implicit` and the `opt_in_source` property as `Account`.
-	 * Importing an existing contact only updates the contact properties you
-	 * include in the request.
+	 * Importing a new contact email address automatically sets the contact's
+	 * `permission_to_send` property as `implicit` and the `opt_in_source`
+	 * property as `Account`. Importing an existing contact only updates the
+	 * contact properties you include in the request.
+	 * Importing contacts with `sms_number`s requires using the `sms_permission_to_send`
+	 * parameter  to specify permissions for all contacts being imported. Set
+	 * to `explicit` to specify that all contacts either provided explicit
+	 * permission. Set to `not_set` if permission was not provided. If `explicit`,
+	 * you must also include the `sms_consent_date` as a column header to include
+	 * the date the contact consented to receiving SMS messages.
+	 * Contacts must have either an email address or an SMS number defined.
+	 *
 	 *
 	 * The CSV file has a maximum of 40,000 lines including the header row
 	 * (39,999 contacts) and a maximum file size of 4 megabytes (MB).  Lines
 	 * above the 40,000 line maximum are not processed. If the request body
 	 * exceeds 4 MB, only the contacts contained in the first 4 MB are imported
 	 * 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`.
+	 * @param string $file The CSV file you are importing  must include either `email` or `sms_number` as a column heading. Other properties you can include using column headings are: `first_name`.  `last_name`, `phone`, `job_title`, `anniversary`, `birthday_day`, `birthday_month`, `company_name`, `street`, `street2`, `city`, `state`, `zip`, `country`, and `sms_consent_date`. 
+
+If adding an `sms_number`, you must also include the `sms_permission_to_send` parameter and set it to either `not_set` or `explicit`. If `explicit`, requires including `sms_consent_date` as a column header to specify the date the contact consented to receiving SMS messages. 
 
 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.
+	 * @param string $sms_permission_to_send If importing contact `sms_number`s, use this parameter to specify how SMS consent was provided. If all contacts in the file provided their consent, set to `explicit` and include each contact's `sms_consent_date`. If all contacts in the file have not yet provided consent, set to `not_set` (`sms_consent_date` is not required). You cannot message a contact that does not have a sms consent date set.
 	 */
-	public function post(string $file, array $list_ids) : ?array
+	public function post(string $file, array $list_ids, ?string $sms_permission_to_send = null) : ?array
 		{
 
-		return $this->doPost(['file' => $file, 'list_ids' => $list_ids, ]);
+		if (null !== $sms_permission_to_send)
+			{
+			$validValues = ['not_set', 'explicit'];
+
+			if (! \in_array($sms_permission_to_send, $validValues))
+				{
+				throw new \PHPFUI\ConstantContact\Exception\InvalidValue("Parameter sms_permission_to_send with value '{$sms_permission_to_send}' is not one of (" . \implode(', ', $validValues) . ') in ' . __METHOD__);
+				}
+			}
+
+		return $this->doPost(['file' => $file, 'list_ids' => $list_ids, 'sms_permission_to_send' => $sms_permission_to_send, ]);
 		}
 
-	public function postTyped(string $file, array $list_ids) : ?\PHPFUI\ConstantContact\Definition\ActivityImport
+	public function postTyped(string $file, array $list_ids, ?string $sms_permission_to_send = null) : ?\PHPFUI\ConstantContact\Definition\ActivityImport
 		{
-		$data = $this->post($file, $list_ids);
+		$data = $this->post($file, $list_ids, $sms_permission_to_send);
 
 		return $data ? new \PHPFUI\ConstantContact\Definition\ActivityImport($data) : null;
 		}

src/ConstantContact/V3/Activities/ContactsJsonImport.php

@@ -18,24 +18,38 @@ public function __construct(\PHPFUI\ConstantContact\Client $client)
 	 * contacts or updates existing contacts by importing a JSON payload. This
 	 * method requires a request body that contains the contact data you are
 	 * importing and the contact lists to which you want to add the imported
-	 * contacts.
-	 * Importing a new contact automatically sets the contact's `permission_to_send`
-	 * property as `implicit` and the `opt_in_source` property as `Account`.
-	 * Importing an existing contact only updates the contact properties you
-	 * include in the request.
-	 * For each contact, you can import up to three addresses and three phone
-	 * numbers. International phone numbers are currently not supported.
+	 * contacts. A contact's data must include an `email` address and/or `sms_number`.
+	 * The `sms_number` must be a US phone number to associate with the contact's
+	 * SMS-enabled phone. Valid formats are <code>1231231234</code> or <code>123-123-1234</code>
+	 * (the country code must be valid).
+	 *
+	 * Importing a new contact using this method automatically sets the contact's
+	 * email `permission_to_send` property to `implicit` and the `opt_in_source`
+	 * property as `Account`. Importing an existing contact only updates the
+	 * contact properties you include in the request. For each contact, you
+	 * can import up to three addresses and three phone numbers. International
+	 * phone numbers are currently not supported.
+	 *
 	 * To import custom fields, prefix the custom field name with `cf:` and
 	 * add it as a contact property. For example, use the property name `cf:first_name`
-	 * if you have a custom field named first_name. The custom field must already
-	 * exist in the Constant Contact account you are using. Each contact can
-	 * contain up to 25 custom fields.
+	 * if you have a custom field named `first_name`. The custom field must
+	 * already exist in the Constant Contact account you are using. Each contact
+	 * can contain up to 25 custom fields.
+	 *
+	 * To include a contact's `sms_number`, if the contact provided explicit
+	 * permission to receive SMS messages, you must set the `sms_permission_to_send`
+	 * property to `explicit` and specify the date of consent using the `sms_consent_date`
+	 * column header. If explicit permission was not provided, set `sms_permission_to_send`
+	 * to `not_set` (the `sms_consent_date` is not required). If the `sms_consent_date`
+	 * is not set, SMS messages cannot be sent to contacts and `sms_permission_to_send`
+	 * defaults to `not_set. Valid value formats for `sms_consent_date` include
+	 * MM/DD/YYYY, M/D/YYYY, YYYY/MM/DD, YYYY/M/D, YYYY-MM-DD, YYYY-M-D,M-D-YYYY,
+	 * or M-DD-YYYY.
 	 *
 	 * The request body payload has a maximum size of 4 megabytes (MB). If
 	 * the request body exceeds 4 MB, this method only imports the first 4
-	 * MB and drops the remaining data.
-	 * Use the activity URL to check the status of the import activity request.
-	 *
+	 * MB and drops the remaining data. Use the activity URL to check the status
+	 * of the import activity request.
 	 *
 	 * @param \PHPFUI\ConstantContact\Definition\ContactsJsonImport $body The JSON request payload that contains the contact data and contact lists for the import.
 	 */