Skip to content

Commit e82e64f

Browse files
committed
V24.6.0 - 2024-06-13
1 parent 90fc841 commit e82e64f

16 files changed

+139
-398
lines changed

Diff for: src/ConstantContact/Definition/BulkCampaignSummary.php

-24
This file was deleted.

Diff for: src/ConstantContact/Definition/BulkSmsCampaignSummariesPercents.php

-22
This file was deleted.

Diff for: src/ConstantContact/Definition/ContactsExport.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* @property array<\PHPFUI\ConstantContact\UUID> $list_ids Exports all of the contacts inside of up to 50 contact lists. This property is mutually exclusive with <code>contact_ids</code>.
1010
* @property int $segment_id Specify the <code>segment_id</code> from which you want to export all contacts that meet the specified <code>segment_criteria</code>. This property is mutually exclusive with <code>contact_ids</code> and <code>list_ids</code>. You can only specify one <code>segment_id</code>.
1111
* @property array $fields Use this array to export specific contact fields. You must export <code>email_address</code> to successfully export <code>email_optin_source</code>, <code>email_optin_date</code>, <code>email_optout_source</code>, <code>email_optout_date</code>, or <code>email_optout_reason</code>.
12-
* @property string $status Allows you to export only contacts that have a specific status value. Possible values are <code>active</code>, <code>unsubscribed</code>, or <code>removed</code>
12+
* @property string $status Allows you to export only contacts that have a specific status value. Possible values are <code>active</code> (billable), <code>unsubscribed</code>, or <code>removed</code>
1313
*/
1414
class ContactsExport extends \PHPFUI\ConstantContact\Definition\Base
1515
{

Diff for: src/ConstantContact/Definition/ListActivityAddContacts.php

+2
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@
66

77
/**
88
* @property \PHPFUI\ConstantContact\Definition\Source $source The <code>source</code> object specifies which contacts you are adding to your targeted lists using one of four mutually exclusive properties.
9+
* @property \PHPFUI\ConstantContact\Definition\Exclude $exclude
910
* @property array<\PHPFUI\ConstantContact\UUID> $list_ids Specifies which lists (up to 50) you are adding your source contacts to.
1011
*/
1112
class ListActivityAddContacts extends \PHPFUI\ConstantContact\Definition\Base
1213
{
1314
protected static array $fields = [
1415
'source' => '\PHPFUI\ConstantContact\Definition\Source',
16+
'exclude' => '\PHPFUI\ConstantContact\Definition\Exclude',
1517
'list_ids' => 'array<\PHPFUI\ConstantContact\UUID>',
1618

1719
];

Diff for: src/ConstantContact/Definition/ListActivityRemoveContacts.php

+4-7
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,16 @@
55
namespace PHPFUI\ConstantContact\Definition;
66

77
/**
8-
* @property \PHPFUI\ConstantContact\Definition\Source $source The <code>source</code> object specifies which contacts to remove from your targeted lists using one of three mutually exclusive properties.
9-
* @property array<\PHPFUI\ConstantContact\UUID> $list_ids Specifies which lists (up to 50) to remove your source contacts from.
8+
* @property \PHPFUI\ConstantContact\Definition\Source $source Specifies the contacts to remove from your target list(s) using one of several mutually exclusive properties.
9+
* @property \PHPFUI\ConstantContact\Definition\Exclude $exclude
10+
* @property array<\PHPFUI\ConstantContact\UUID> $list_ids Specify up to 50 target <code>list_id</code>s from which to remove contacts.
1011
*/
1112
class ListActivityRemoveContacts extends \PHPFUI\ConstantContact\Definition\Base
1213
{
1314
protected static array $fields = [
1415
'source' => '\PHPFUI\ConstantContact\Definition\Source',
16+
'exclude' => '\PHPFUI\ConstantContact\Definition\Exclude',
1517
'list_ids' => 'array<\PHPFUI\ConstantContact\UUID>',
1618

17-
];
18-
19-
protected static array $maxLength = [
20-
'list_ids' => 50,
21-
2219
];
2320
}

Diff for: src/ConstantContact/Definition/Provision.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* @property string $time_zone_id The offical time zone to use to represent the physical location associated with the client account.
1515
* @property string $website The client's website URL. Specifying the website URL eliminates the need for clients to provide that information. Requires a valid URL starting with http:// or https://.
1616
* @property string $login_name A unique login name to associate with the client account. The name must only contain alphanumeric characters and '-', '_', '@','.','+'.
17-
* @property string $password Required if not using Single Sign On (SSO) or external authenticator. The password to associate with the client account. Passwords must be a minimum of six characters in length and have no spaces. The password is not returned in the response payload for security reasons. If using SSO authentication, use <code>external_provider</code> and <code>external_id</code> instead of <code>password</code>.
17+
* @property string $password Required if not using Single Sign On (SSO) or external authenticator. The password to associate with the client account. Passwords must be at least 8 characters and no more than 80 characters in length. Passwords can contain alphabetical letters (A-Z) and (a-z), numbers (0-9), special characters (! @ # $ etc.) and spaces. Passwords should not contain any part of your username and cannot be the same as your last password, or be listed on an industry database; we check for easily guessed or compromised passwords. Your new password is not returned in the response payload for security reasons. If using SSO authentication, use <code>idp_provider</code> and <code>idp_provider_id</code> instead of <code>password</code>.
1818
* @property string $first_name The client account owner's first name.
1919
* @property string $last_name The client account owner's last name.
2020
* @property string $partner_account_id The unique client account identifier that partners define and use for billing and reporting purposes.
@@ -72,7 +72,7 @@ class Provision extends \PHPFUI\ConstantContact\Definition\Base
7272
'organization_name' => 1,
7373
'organization_phone' => 5,
7474
'login_name' => 6,
75-
'password' => 6,
75+
'password' => 8,
7676
'first_name' => 2,
7777
'last_name' => 2,
7878

Diff for: src/ConstantContact/Definition/ReportingsmsLinks.php

-16
This file was deleted.

Diff for: src/ConstantContact/Definition/ReportingsmsNext.php

-16
This file was deleted.

Diff for: src/ConstantContact/Definition/SmsCampaignSummariesPage.php

-20
This file was deleted.

Diff for: src/ConstantContact/Definition/Source.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
* @property array<\PHPFUI\ConstantContact\UUID> $contact_ids An array of contacts IDs.
99
* @property array<\PHPFUI\ConstantContact\UUID> $list_ids An array of list IDs ( <code>list_id</code> ).
1010
* @property array<\PHPFUI\ConstantContact\UUID> $tag_ids An array of tags ( <code>tag_id</code> ).
11-
* @property bool $all_active_contacts Use to identify contacts with an active status.
11+
* @property bool $all_active_contacts Use to identify contacts with an active (billable) status.
1212
* @property bool $new_subscriber Use to identify newly subscribed contacts.
1313
*/
1414
class Source extends \PHPFUI\ConstantContact\Definition\Base

Diff for: src/ConstantContact/Definition/TagAddRemoveContacts.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
/**
88
* @property \PHPFUI\ConstantContact\Definition\Source $source Select the source used to identify contacts to which a tag is added or removed. Source types are mutually exclusive.
9-
* @property \PHPFUI\ConstantContact\Definition\Exclude $exclude Use to exclude specified contacts from being added or removed from a tag. Only applicable if the specified source is either <code>all_active_contacts</code> or <code>list_ids</code>.
9+
* @property \PHPFUI\ConstantContact\Definition\Exclude $exclude Use to exclude specified contacts from being added or removed from a tag. Only applicable if the specified source is either <code>all_active_contacts</code> (billable) or <code>list_ids</code>.
1010
* @property array<\PHPFUI\ConstantContact\UUID> $tag_ids An array of tags (<code>tag_id</code>) to add to all contacts meeting the specified source criteria.
1111
*/
1212
class TagAddRemoveContacts extends \PHPFUI\ConstantContact\Definition\Base

Diff for: src/ConstantContact/Definition/UniqueSmsCounts.php

-24
This file was deleted.

Diff for: src/ConstantContact/V3/Activities/RemoveListMemberships.php

+7-4
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,14 @@ public function __construct(\PHPFUI\ConstantContact\Client $client)
1515
* Remove Contacts from Lists
1616
*
1717
* Use this method to create an activity that removes contacts from one
18-
* or more lists. Use the properties in the `source` object to remove specific
19-
* contacts from your targeted lists. Use the `list_ids` array to specify
20-
* the lists from which you want to remove the source contacts.
18+
* or more contact lists. Use the properties in the `source` object to
19+
* remove specific contacts from your lists. Use the `list_ids` array to
20+
* specify the target lists from which contacts are removed. Optionally,
21+
* if the source is `all_active_contacts` (billable) or `list_ids`, use
22+
* the `exclude` object to exclude specific contacts from being removed
23+
* from the destination lists.
2124
*
22-
* @param \PHPFUI\ConstantContact\Definition\ListActivityRemoveContacts $body The JSON payload used to create the 'remove contacts from lists' activity
25+
* @param \PHPFUI\ConstantContact\Definition\ListActivityRemoveContacts $body The JSON payload used to create the Remove Contacts from Lists' activity
2326
*/
2427
public function post(\PHPFUI\ConstantContact\Definition\ListActivityRemoveContacts $body) : array
2528
{

Diff for: src/ConstantContact/V3/Contacts/Counts.php

+6-5
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,13 @@ public function __construct(\PHPFUI\ConstantContact\Client $client)
1616
*
1717
* Use to get the total contacts count for the account and the total contact-consent
1818
* counts for each consent state. Optionally, to include the total number
19-
* of new subscribers in the results, use `new_subscribers` in the `include`
20-
* query parameter. To optimize open rates, reduce spam reports, and help
21-
* grow your business, you must value your contact's consent to receive
22-
* or to not receive your emails.
19+
* of contacts that subscribed within the last 30 days in the results,
20+
* use `new_subscribers` in the `include` query parameter. To optimize
21+
* open rates, reduce spam reports, and help grow your business, you must
22+
* value your contact's consent to receive or to not receive your emails.
2323
*
24-
* @param string $include Use to return the total number of new contact subscribers in the results.
24+
*
25+
* @param string $include Use to return the total number of contacts that subscribed within the last 30 days in the results.
2526
*/
2627
public function get(?string $include = null) : array
2728
{

Diff for: src/ConstantContact/V3/Reports/SummaryReports/SmsCampaignSummaries.php

-34
This file was deleted.

0 commit comments

Comments
 (0)