Skip to content

Commit 87dd954

Browse files
phpfuiphpfui
committed
V24.11.3 - 2024-11-06
1 parent e4b2581 commit 87dd954

11 files changed

+428
-50
lines changed

‎src/ConstantContact/Definition/BulkCampaignSummary.php

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<?php
2+
3+
// Generated file. Do not edit by hand. Use update.php in project root.
4+
5+
namespace PHPFUI\ConstantContact\Definition;
6+
7+
/**
8+
* @property \PHPFUI\ConstantContact\UUID $campaign_id The ID that uniquely identifies the campaign.
9+
* @property string $campaign_name The name to associate with this campaign.
10+
* @property \PHPFUI\ConstantContact\DateTime $last_sent_date The date that the campaign was last sent.
11+
* @property \PHPFUI\ConstantContact\Definition\UniqueSmsCounts $unique_counts The total number of times each unique contact interacted with a tracked SMS campaign activity.
12+
* @property string $campaign_type The campaign type.
13+
*/
14+
class BulkCampaignSummary extends \PHPFUI\ConstantContact\Definition\Base
15+
{
16+
protected static array $fields = [
17+
'campaign_id' => '\PHPFUI\ConstantContact\UUID',
18+
'campaign_name' => 'string',
19+
'last_sent_date' => '\PHPFUI\ConstantContact\DateTime',
20+
'unique_counts' => '\PHPFUI\ConstantContact\Definition\UniqueSmsCounts',
21+
'campaign_type' => 'string',
22+
23+
];
24+
}

‎src/ConstantContact/Definition/BulkSmsCampaignSummariesPercents.php

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<?php
2+
3+
// Generated file. Do not edit by hand. Use update.php in project root.
4+
5+
namespace PHPFUI\ConstantContact\Definition;
6+
7+
/**
8+
* @property int $deliver The aggregated SMS delivery rate for all campaigns on the current results page.
9+
* @property int $click The aggregated click rate for all campaigns on the current results page.
10+
* @property int $bounce The aggregated bounce rate for all campaigns on the current results page.
11+
* @property int $unsubscribe The aggregated unsubscribe (opt-out) rate for all campaigns on the current results page.
12+
*/
13+
class BulkSmsCampaignSummariesPercents extends \PHPFUI\ConstantContact\Definition\Base
14+
{
15+
protected static array $fields = [
16+
'deliver' => 'int',
17+
'click' => 'int',
18+
'bounce' => 'int',
19+
'unsubscribe' => 'int',
20+
21+
];
22+
}

‎src/ConstantContact/Definition/ContactsExport.php

+12-5
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,33 @@
55
namespace PHPFUI\ConstantContact\Definition;
66

77
/**
8-
* @property array<\PHPFUI\ConstantContact\UUID> $contact_ids Exports up to 500 specific contacts. This property is mutually exclusive with <code>list_ids</code>.
9-
* @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>.
10-
* @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>.
11-
* @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> (billable), <code>unsubscribed</code>, or <code>removed</code>. Applicable with either `contact_ids` or `list_ids` as the source.
8+
* @property array<\PHPFUI\ConstantContact\UUID> $contact_ids Exports up to 500 specific contacts. This property is mutually exclusive with all other filtering criteria except with<code>status</code>.
9+
* @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 all other filtering criteria except with either <code>status</code> or <code>exclude</code>.
10+
* @property array<\PHPFUI\ConstantContact\UUID> $tag_ids Exports contacts assigned one or more of the tags (<code>tag_id</code>) specified. This property is mutually exclusive with all other filtering criteria.
11+
* @property bool $new_subscriber Set to <code>true</code> to only export contacts that subscribed within the last 30 days. Default setting is <code>false</code>. This property is mutually exclusive with all other filtering criteria except with either <code>list_ids</code> or <code>exclude</code>.
12+
* @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>. You can only specify one <code>segment_id</code>. This property is mutually exclusive with all other filtering criteria.
13+
* @property array $fields By default , all fields are returned. Use this array to only 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>.
14+
* @property string $status Allows you to export only contacts that have a specific status value. This property is mutually exclusive with all other filtering criteria except with either <code>contact_ids</code> or <code>list_ids</code>.
15+
* @property \PHPFUI\ConstantContact\Definition\Exclude $exclude
1316
*/
1417
class ContactsExport extends \PHPFUI\ConstantContact\Definition\Base
1518
{
1619
protected static array $fields = [
1720
'contact_ids' => 'array<\PHPFUI\ConstantContact\UUID>',
1821
'list_ids' => 'array<\PHPFUI\ConstantContact\UUID>',
22+
'tag_ids' => 'array<\PHPFUI\ConstantContact\UUID>',
23+
'new_subscriber' => 'bool',
1924
'segment_id' => 'int',
2025
'fields' => 'array',
2126
'status' => 'string',
27+
'exclude' => '\PHPFUI\ConstantContact\Definition\Exclude',
2228

2329
];
2430

2531
protected static array $maxLength = [
2632
'contact_ids' => 500,
2733
'list_ids' => 50,
34+
'tag_ids' => 50,
2835

2936
];
3037
}

‎src/ConstantContact/Definition/ReportingsmsLinks.php

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<?php
2+
3+
// Generated file. Do not edit by hand. Use update.php in project root.
4+
5+
namespace PHPFUI\ConstantContact\Definition;
6+
7+
/**
8+
* @property \PHPFUI\ConstantContact\Definition\ReportingsmsNext $next Contains the next link if it is available.
9+
*/
10+
class ReportingsmsLinks extends \PHPFUI\ConstantContact\Definition\Base
11+
{
12+
protected static array $fields = [
13+
'next' => '\PHPFUI\ConstantContact\Definition\ReportingsmsNext',
14+
15+
];
16+
}

‎src/ConstantContact/Definition/ReportingsmsNext.php

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<?php
2+
3+
// Generated file. Do not edit by hand. Use update.php in project root.
4+
5+
namespace PHPFUI\ConstantContact\Definition;
6+
7+
/**
8+
* @property string $href The next link in the page or null if there are no additional pages.
9+
*/
10+
class ReportingsmsNext extends \PHPFUI\ConstantContact\Definition\Base
11+
{
12+
protected static array $fields = [
13+
'href' => 'string',
14+
15+
];
16+
}

‎src/ConstantContact/Definition/SmsCampaignSummariesPage.php

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<?php
2+
3+
// Generated file. Do not edit by hand. Use update.php in project root.
4+
5+
namespace PHPFUI\ConstantContact\Definition;
6+
7+
/**
8+
* @property array<\PHPFUI\ConstantContact\Definition\BulkCampaignSummary> $bulk_sms_campaign_summaries Provides details about each SMS campaign, including the total unique counts for each tracked campaign activity.
9+
* @property \PHPFUI\ConstantContact\Definition\BulkSmsCampaignSummariesPercents $aggregate_percents Campaign activity aggregate percents, including <code>click</code>, <code> deliver</code>, <code> bounce</code>, and <code>unsubscribe</code>, for all SMS campaigns returned on a page of results.
10+
* @property \PHPFUI\ConstantContact\Definition\ReportingsmsLinks $_links HAL property that contains next link if applicable
11+
*/
12+
class SmsCampaignSummariesPage extends \PHPFUI\ConstantContact\Definition\Base
13+
{
14+
protected static array $fields = [
15+
'bulk_sms_campaign_summaries' => 'array<\PHPFUI\ConstantContact\Definition\BulkCampaignSummary>',
16+
'aggregate_percents' => '\PHPFUI\ConstantContact\Definition\BulkSmsCampaignSummariesPercents',
17+
'_links' => '\PHPFUI\ConstantContact\Definition\ReportingsmsLinks',
18+
19+
];
20+
}

‎src/ConstantContact/Definition/UniqueSmsCounts.php

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<?php
2+
3+
// Generated file. Do not edit by hand. Use update.php in project root.
4+
5+
namespace PHPFUI\ConstantContact\Definition;
6+
7+
/**
8+
* @property int $sends The total number of unique sends.
9+
* @property int $delivers The total number of SMS delivered.
10+
* @property int $opens The total number of unique opens.
11+
* @property int $clicks The total number of unique clicks.
12+
* @property int $optouts The total number of unique opt-outs (unsubscribes).
13+
*/
14+
class UniqueSmsCounts extends \PHPFUI\ConstantContact\Definition\Base
15+
{
16+
protected static array $fields = [
17+
'sends' => 'int',
18+
'delivers' => 'int',
19+
'opens' => 'int',
20+
'clicks' => 'int',
21+
'optouts' => 'int',
22+
23+
];
24+
}

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ public function getTyped() : ?\PHPFUI\ConstantContact\Definition\AccountPhysical
4545
* United States (<code>US</code>) and Canada (<code>CA</code>) addresses,
4646
* or use the <code>state_name</code> to specify all other countries.
4747
*
48-
* @param \PHPFUI\ConstantContact\Definition\AccountPhysicalAddress $body Include all `AccountPhysicalAddress` properties required for the specified `country_code` and then update only those properties that you want to change. Excluding a non-read only field from the request body removes it from the physical address.
48+
* @param \PHPFUI\ConstantContact\Definition\AccountPhysicalAddress $body Include all `AccountPhysicalAddress` properties required for the specified `country_code`. If a required property is not included or incorrectly formatted, a 400 error message is returned. If the address already exists, a 409 error message is returned.
4949
*/
5050
public function post(\PHPFUI\ConstantContact\Definition\AccountPhysicalAddress $body) : ?array
5151
{

‎src/ConstantContact/V3/Activities/ContactExports.php

+5-9
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,11 @@ public function __construct(\PHPFUI\ConstantContact\Client $client)
1515
* Export Contacts to a File
1616
*
1717
* Use this method to create an activity that exports contacts and contact
18-
* details to a CSV file. By default, all contacts are exported. To filter
19-
* contacts to export, specify the source to use, `contact_id`, `list_id`,
20-
* or `segment_id` (all mutually exclusive).
21-
* By default, all contact related fields are exported. Use the fields
22-
* array to only export specific contact fields. You must export `email_address`
23-
* to successfully export `email_optin_source`, `email_optin_date`, `email_optout_source`,
24-
* `email_optout_date`, or `email_optout_reason`.
25-
* After Constant Contact finishes processing the activity, use the `results`
26-
* link in the response body to retrieve the CSV file.
18+
* details to a CSV file. You can choose to export all contacts in your
19+
* account (default) or you can use parameters to filter on which contacts
20+
* to export. After Constant Contact finishes processing the activity,
21+
* use the `results` link in the response body to retrieve the CSV file.
22+
*
2723
*
2824
* @param \PHPFUI\ConstantContact\Definition\ContactsExport $body A JSON payload that specifies the contacts (rows in the CSV file) and contact properties (columns in the CSV file) you want to export.
2925
*/

‎src/ConstantContact/V3/Reports/SummaryReports/SmsCampaignSummaries.php

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<?php
2+
3+
// Generated file. Do not edit by hand. Use update.php in project root.
4+
5+
namespace PHPFUI\ConstantContact\V3\Reports\SummaryReports;
6+
7+
class SmsCampaignSummaries extends \PHPFUI\ConstantContact\Base
8+
{
9+
public function __construct(\PHPFUI\ConstantContact\Client $client)
10+
{
11+
parent::__construct($client, '/v3/reports/summary_reports/sms_campaign_summaries');
12+
}
13+
14+
/**
15+
* GET an SMS Campaigns Summary Report
16+
*
17+
* Use this method to get SMS campaign summary details, including the total
18+
* number of times that each contact uniquely interacted with each tracked
19+
* campaign activity and aggregate tracking statistics. Results are sorted
20+
* in descending order by the date the SMS was last sent (`last_sent_date`).
21+
*
22+
* The `start_at` date is required. Use both the `start_at` and `end_at`
23+
* date query parameters to return only SMS campaign summary details that
24+
* occurred within a specified date range.
25+
* Use the `limit` query parameter to limit the number of results returned
26+
* per page.
27+
*
28+
* @param string $limit Use to limit the number of results to return on a single page (from 1 to 50). The default setting is 50.
29+
* @param string $start_at Use to limit the results to include SMS campaign summary details for SMS campaigns sent on or after the required `start_at` date you specify. ISO 8601 format.
30+
* @param string $end_at Use to limit the results to include SMS campaign summary details for SMS campaigns sent on or before the `end_at` date you specify. ISO 8601 format.
31+
*/
32+
public function get(?string $limit = null, string $start_at, ?string $end_at = null) : ?array
33+
{
34+
35+
return $this->doGet(['limit' => $limit, 'start_at' => $start_at, 'end_at' => $end_at, ]);
36+
}
37+
38+
public function getTyped(?string $limit = null, string $start_at, ?string $end_at = null) : ?\PHPFUI\ConstantContact\Definition\SmsCampaignSummariesPage
39+
{
40+
$data = $this->get($limit, $start_at, $end_at);
41+
42+
return $data ? new \PHPFUI\ConstantContact\Definition\SmsCampaignSummariesPage($data) : null;
43+
}
44+
45+
}

0 commit comments

Comments
 (0)