V24.4.0 - 2024-04-16

Author: phpfui

src/ConstantContact/Definition/BulkCampaignSummary.php

@@ -0,0 +1,24 @@
+<?php
+
+// Generated file. Do not edit by hand. Use update.php in project root.
+
+namespace PHPFUI\ConstantContact\Definition;
+
+/**
+ * @property \PHPFUI\ConstantContact\UUID $campaign_id The ID that uniquely identifies the campaign.
+ * @property string $campaign_name The name to associate with this campaign.
+ * @property \PHPFUI\ConstantContact\DateTime $last_sent_date The date that the campaign was last sent.
+ * @property \PHPFUI\ConstantContact\Definition\UniqueSmsCounts $unique_counts Aggregate counts for email tracking metrics unique across contacts and channels
+ * @property string $campaign_type The campaign type.
+ */
+class BulkCampaignSummary extends \PHPFUI\ConstantContact\Definition\Base
+	{
+	protected static array $fields = [
+		'campaign_id' => '\PHPFUI\ConstantContact\UUID',
+		'campaign_name' => 'string',
+		'last_sent_date' => '\PHPFUI\ConstantContact\DateTime',
+		'unique_counts' => '\PHPFUI\ConstantContact\Definition\UniqueSmsCounts',
+		'campaign_type' => 'string',
+
+	];
+	}

src/ConstantContact/Definition/BulkSmsCampaignSummariesPercents.php

@@ -0,0 +1,22 @@
+<?php
+
+// Generated file. Do not edit by hand. Use update.php in project root.
+
+namespace PHPFUI\ConstantContact\Definition;
+
+/**
+ * @property int $deliver The aggregated SMS delivery rate for all campaigns on the current results page.
+ * @property int $click The aggregated click rate for all campaigns on the current results page.
+ * @property int $bounce The aggregated bounce rate for all campaigns on the current results page.
+ * @property int $unsubscribe The aggregated unsubscribe (opt-out) rate for all campaigns on the current results page.
+ */
+class BulkSmsCampaignSummariesPercents extends \PHPFUI\ConstantContact\Definition\Base
+	{
+	protected static array $fields = [
+		'deliver' => 'int',
+		'click' => 'int',
+		'bounce' => 'int',
+		'unsubscribe' => 'int',
+
+	];
+	}

src/ConstantContact/Definition/ReportingsmsLinks.php

@@ -0,0 +1,16 @@
+<?php
+
+// Generated file. Do not edit by hand. Use update.php in project root.
+
+namespace PHPFUI\ConstantContact\Definition;
+
+/**
+ * @property \PHPFUI\ConstantContact\Definition\ReportingsmsNext $next Contains the next link if it is available.
+ */
+class ReportingsmsLinks extends \PHPFUI\ConstantContact\Definition\Base
+	{
+	protected static array $fields = [
+		'next' => '\PHPFUI\ConstantContact\Definition\ReportingsmsNext',
+
+	];
+	}

src/ConstantContact/Definition/ReportingsmsNext.php

@@ -0,0 +1,16 @@
+<?php
+
+// Generated file. Do not edit by hand. Use update.php in project root.
+
+namespace PHPFUI\ConstantContact\Definition;
+
+/**
+ * @property string $href The next link in the page or null if there are no additional pages.
+ */
+class ReportingsmsNext extends \PHPFUI\ConstantContact\Definition\Base
+	{
+	protected static array $fields = [
+		'href' => 'string',
+
+	];
+	}

src/ConstantContact/Definition/SmsCampaignSummariesPage.php

@@ -0,0 +1,20 @@
+<?php
+
+// Generated file. Do not edit by hand. Use update.php in project root.
+
+namespace PHPFUI\ConstantContact\Definition;
+
+/**
+ * @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.
+ * @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.
+ * @property \PHPFUI\ConstantContact\Definition\ReportingsmsLinks $_links HAL property that contains next link if applicable
+ */
+class SmsCampaignSummariesPage extends \PHPFUI\ConstantContact\Definition\Base
+	{
+	protected static array $fields = [
+		'bulk_sms_campaign_summaries' => 'array<\PHPFUI\ConstantContact\Definition\BulkCampaignSummary>',
+		'aggregate_percents' => '\PHPFUI\ConstantContact\Definition\BulkSmsCampaignSummariesPercents',
+		'_links' => '\PHPFUI\ConstantContact\Definition\ReportingsmsLinks',
+
+	];
+	}

src/ConstantContact/Definition/UniqueSmsCounts.php

@@ -0,0 +1,24 @@
+<?php
+
+// Generated file. Do not edit by hand. Use update.php in project root.
+
+namespace PHPFUI\ConstantContact\Definition;
+
+/**
+ * @property int $sends The total number of unique sends.
+ * @property int $clicks The total number of unique clicks.
+ * @property int $optouts The total number of unique opt-outs (unsubscribes).
+ * @property int $delivers The total number of SMS delivered.
+ * @property int $bounces The total number of unique bounces.
+ */
+class UniqueSmsCounts extends \PHPFUI\ConstantContact\Definition\Base
+	{
+	protected static array $fields = [
+		'sends' => 'int',
+		'clicks' => 'int',
+		'optouts' => 'int',
+		'delivers' => 'int',
+		'bounces' => 'int',
+
+	];
+	}

src/ConstantContact/V3/Partner/Accounts/Users/Sso.php

@@ -15,8 +15,7 @@ public function __construct(\PHPFUI\ConstantContact\Client $client)
 	 * POST a User Under a Partner's SSO-Enabled Client Account
 	 *
 	 * Use this endpoint to create a new user under a partner client account
-	 * that has the Single Sign On (SSO) for all users feature is enabled.
-	 *
+	 * that has the Single Sign On (SSO) for all users feature enabled.
 	 *
 	 * @param string $encoded_account_id The encoded account ID that identifies the partner's client account to which to add the new user. 
 	 * @param \PHPFUI\ConstantContact\Definition\SSOUser $SSO_User The JSON payload used to create a new user under the specified partner's client account. All request body properties are required (`first_name`, `last_name`, `role_name`, `contact_email`, `login_name`, `external_id`, `external_provider`).

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

@@ -0,0 +1,34 @@
+<?php
+
+// Generated file. Do not edit by hand. Use update.php in project root.
+
+namespace PHPFUI\ConstantContact\V3\Reports\SummaryReports;
+
+class SmsCampaignSummaries extends \PHPFUI\ConstantContact\Base
+	{
+	public function __construct(\PHPFUI\ConstantContact\Client $client)
+		{
+		parent::__construct($client, '/v3/reports/summary_reports/sms_campaign_summaries');
+		}
+
+	/**
+	 * GET an SMS Campaigns Summary Report
+	 *
+	 * Use this method to get a summary of aggregate tracking statistics for
+	 * up to 500 SMS campaigns.
+	 * The response results include the total number of times that each contact
+	 * uniquely interacted with each tracked campaign activity. Results are
+	 * sorted in descending order by the date the SMS was last sent (`last_sent_date`).
+	 * Use the `limit` query parameter to limit the number of results returned
+	 * per page. For example, if you may want to compare the tracking statistics
+	 * for the last five SMS campaigns to those in the previous five SMS campaigns,
+	 * set the `limit` parameter to `5`.
+	 *
+	 * @param string $limit Use to limit the number of results to return on a single page. The default is `50` and the maximum is `500` per page.
+	 */
+	public function get(?string $limit = null) : array
+		{
+
+		return $this->doGet(['limit' => $limit, ]);
+		}
+	}