Skip to content

Commit fb6d804

Browse files
committed
V24.1.0 - 2024-01-14
1 parent bffc456 commit fb6d804

32 files changed

+3265
-1303
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
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 $suspend_plan_id Suspended plan group id.
9+
* @property int $suspend_plan_group_id The suspended plan group id.
10+
* @property \PHPFUI\ConstantContact\DateTime $suspend_date The date when the customer will start being suspended. If omitted defaults to the current date and time and suspends the account at the next billing cycle.
11+
* @property int $suspend_reason_id The reason the customer is suspended.
12+
* @property int $suspend_subreason_id The subreason why the customer is suspended.
13+
* @property string $suspend_comment Comment field for user suspension.
14+
* @property \PHPFUI\ConstantContact\DateTime $suspend_estimated_reactivation_date Estimated date when the customer will be reactivated.
15+
*/
16+
class AccountSuspension extends \PHPFUI\ConstantContact\Definition\Base
17+
{
18+
protected static array $fields = [
19+
'suspend_plan_id' => 'int',
20+
'suspend_plan_group_id' => 'int',
21+
'suspend_date' => '\PHPFUI\ConstantContact\DateTime',
22+
'suspend_reason_id' => 'int',
23+
'suspend_subreason_id' => 'int',
24+
'suspend_comment' => 'string',
25+
'suspend_estimated_reactivation_date' => '\PHPFUI\ConstantContact\DateTime',
26+
27+
];
28+
}
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
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 $activity_id Unique ID for the activity.
9+
* @property string $state The state of the request: <p><ul> <li>initialized - request has been received</li> <li>processing - request is being processed</li> <li>completed - job completed</li> <li>cancelled - request was cancelled</li> <li>failed - job failed to complete</li> <li>timed_out - the request timed out before completing"</li> </ul> </p>
10+
* @property \PHPFUI\ConstantContact\DateTime $started_at Timestamp showing when we began processing the activity request, in ISO-8601 format.
11+
* @property \PHPFUI\ConstantContact\DateTime $completed_at Timestamp showing when we completed processing the activity, in ISO-8601 format.
12+
* @property \PHPFUI\ConstantContact\DateTime $created_at Timestamp showing when we created the activity, in ISO-8601 format.
13+
* @property \PHPFUI\ConstantContact\DateTime $updated_at Timestamp showing when we last updated the activity, in ISO-8601 format.
14+
* @property int $percent_done Shows the percent done for an activity that we are still processing.
15+
* @property array $activity_errors Array of messages describing the errors that occurred.
16+
* @property \PHPFUI\ConstantContact\Definition\Link $_links
17+
*/
18+
class ActivityDeleteCustomFields extends \PHPFUI\ConstantContact\Definition\Base
19+
{
20+
protected static array $fields = [
21+
'activity_id' => '\PHPFUI\ConstantContact\UUID',
22+
'state' => ['initialized', 'processing', 'completed', 'cancelled', 'failed', 'timed_out'],
23+
'started_at' => '\PHPFUI\ConstantContact\DateTime',
24+
'completed_at' => '\PHPFUI\ConstantContact\DateTime',
25+
'created_at' => '\PHPFUI\ConstantContact\DateTime',
26+
'updated_at' => '\PHPFUI\ConstantContact\DateTime',
27+
'percent_done' => 'int',
28+
'activity_errors' => 'array',
29+
'_links' => '\PHPFUI\ConstantContact\Definition\Link',
30+
31+
];
32+
}

src/ConstantContact/Definition/BulkEmailCampaignSummariesPage.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@
66

77
/**
88
* @property array<\PHPFUI\ConstantContact\Definition\BulkEmailCampaignSummary> $bulk_email_campaign_summaries Lists and provides details about each bulk email campaign activity including total unique counts for tracked activities.
9+
* @property \PHPFUI\ConstantContact\Definition\BulkEmailCampaignSummariesPercents $aggregate_percents Lists aggregate percents for `click`, `open`, `did_not_open`, `bounce`, and `unsubscribe` activities for all campaigns included on a page of results.
910
* @property \PHPFUI\ConstantContact\Definition\Links2 $_links HAL property that contains next link if applicable
1011
*/
1112
class BulkEmailCampaignSummariesPage extends \PHPFUI\ConstantContact\Definition\Base
1213
{
1314
protected static array $fields = [
1415
'bulk_email_campaign_summaries' => 'array<\PHPFUI\ConstantContact\Definition\BulkEmailCampaignSummary>',
16+
'aggregate_percents' => '\PHPFUI\ConstantContact\Definition\BulkEmailCampaignSummariesPercents',
1517
'_links' => '\PHPFUI\ConstantContact\Definition\Links2',
1618

1719
];
Lines changed: 24 additions & 0 deletions
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 $click Aggregated click rate for campaigns on the current page.
9+
* @property int $open Aggregated open rate for campaigns on the current page.
10+
* @property int $did_not_open Aggregated did-not-open rate for campaigns on the current page.
11+
* @property int $bounce Aggregated bounce rate for campaigns on the current page.
12+
* @property int $unsubscribe Aggregated unsubscribe (optout) rate for campaigns on the current page.
13+
*/
14+
class BulkEmailCampaignSummariesPercents extends \PHPFUI\ConstantContact\Definition\Base
15+
{
16+
protected static array $fields = [
17+
'click' => 'int',
18+
'open' => 'int',
19+
'did_not_open' => 'int',
20+
'bounce' => 'int',
21+
'unsubscribe' => 'int',
22+
23+
];
24+
}

src/ConstantContact/Definition/ContactTrackingActivity.php

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,11 @@
55
namespace PHPFUI\ConstantContact\Definition;
66

77
/**
8-
* @property \PHPFUI\ConstantContact\UUID $contact_id The contact id.
9-
* @property \PHPFUI\ConstantContact\UUID $campaign_activity_id The unique id of the activity for an e-mail campaign.
8+
* @property \PHPFUI\ConstantContact\UUID $contact_id The contact ID.
9+
* @property \PHPFUI\ConstantContact\UUID $campaign_activity_id The unique ID of the activity for an e-mail campaign.
1010
* @property \PHPFUI\ConstantContact\DateTime $created_time The time the tracking activity occurred
11-
* @property string $tracking_activity_type The type of the tracking activity (send, open, click, bounce, opt-out or forward to a friend)
11+
* @property string $tracking_activity_type The types of the tracking activities included in the request. For example, sends, opens, clicks, bounces, opt-outs, or forwards.
12+
* @property string $campaign_activity_name The campaign activity name.
1213
*/
1314
class ContactTrackingActivity extends \PHPFUI\ConstantContact\Definition\Base
1415
{
@@ -17,6 +18,7 @@ class ContactTrackingActivity extends \PHPFUI\ConstantContact\Definition\Base
1718
'campaign_activity_id' => '\PHPFUI\ConstantContact\UUID',
1819
'created_time' => '\PHPFUI\ConstantContact\DateTime',
1920
'tracking_activity_type' => 'string',
21+
'campaign_activity_name' => 'string',
2022

2123
];
2224
}
Lines changed: 16 additions & 0 deletions
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 array<\PHPFUI\ConstantContact\UUID> $custom_field_ids The array of custom field IDs to delete.
9+
*/
10+
class CustomFieldId100 extends \PHPFUI\ConstantContact\Definition\Base
11+
{
12+
protected static array $fields = [
13+
'custom_field_ids' => 'array<\PHPFUI\ConstantContact\UUID>',
14+
15+
];
16+
}
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
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 $state The code representing the consent state, including <code>E</code> for optin and <code>O</code> for Optin.
9+
* @property string $source The code representing the consent source type, including <code>A</code> for Account, <code>C</code> for Contact, and <code>S</code>' for System.
10+
* @property string $consent_type The type of SMS consent used.
11+
* @property \PHPFUI\ConstantContact\DateTime $consent_action_time The date and time that SMS engagement data was last updated, in ISO-8601 format. System generated.
12+
* @property string $consent_action_type The type of consent action provided.
13+
* @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>).
14+
* @property string $source_consent_timestamp The time that SMS consent was last updated.
15+
* @property string $source_ip If applicable, the IP address from which the consent came.
16+
* @property string $source_sms_number If applicable, the SMS consent number associated with the source.
17+
* @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.
18+
* @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.
19+
*/
20+
class HistoryDetails extends \PHPFUI\ConstantContact\Definition\Base
21+
{
22+
protected static array $fields = [
23+
'state' => ['E', 'O'],
24+
'source' => ['A', 'C', 'S'],
25+
'consent_type' => ['promotional_sms', 'transactional_sms'],
26+
'consent_action_time' => '\PHPFUI\ConstantContact\DateTime',
27+
'consent_action_type' => ['opt_out', 're_opt_in', 'delete', 'confirmed_opt_in', 'deactivate', 'suspend', 'resubscribe'],
28+
'consent_medium_type' => ['MD', 'LF', 'CD', 'FI', 'SY'],
29+
'source_consent_timestamp' => 'string',
30+
'source_ip' => 'string',
31+
'source_sms_number' => 'string',
32+
'advertised_frequency' => 'int',
33+
'advertised_interval' => ['M', 'D', 'W'],
34+
35+
];
36+
}
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
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\PContactAddTrackingActivity> $tracking_activities The list of landing page contact adds tracking activities.
9+
* @property \PHPFUI\ConstantContact\Definition\Links2 $_links HAL property that contains next link if applicable
10+
*/
11+
class PContactAddTrackingActivitiesPage extends \PHPFUI\ConstantContact\Definition\Base
12+
{
13+
protected static array $fields = [
14+
'tracking_activities' => 'array<\PHPFUI\ConstantContact\Definition\PContactAddTrackingActivity>',
15+
'_links' => '\PHPFUI\ConstantContact\Definition\Links2',
16+
17+
];
18+
}
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
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 $contact_id The unique ID that identifies the contact.
9+
* @property \PHPFUI\ConstantContact\UUID $campaign_activity_id The unique ID that identifies of the campaign activity to use.
10+
* @property string $tracking_activity_type The tracked activity event type.
11+
* @property string $email_address The email address for the contact and tracking activity.
12+
* @property string $first_name The first name of the contact.
13+
* @property string $last_name The last name of the contact.
14+
* @property \PHPFUI\ConstantContact\DateTime $created_time The time the tracking activity occurred.
15+
* @property \PHPFUI\ConstantContact\Date $deleted_at The time the Contact was deleted
16+
* @property \PHPFUI\ConstantContact\Definition\TrackingActivitySmsChannelDTO $sms_channel Sms channel info for this contact
17+
*/
18+
class PContactAddTrackingActivity extends \PHPFUI\ConstantContact\Definition\Base
19+
{
20+
protected static array $fields = [
21+
'contact_id' => '\PHPFUI\ConstantContact\UUID',
22+
'campaign_activity_id' => '\PHPFUI\ConstantContact\UUID',
23+
'tracking_activity_type' => 'string',
24+
'email_address' => 'string',
25+
'first_name' => 'string',
26+
'last_name' => 'string',
27+
'created_time' => '\PHPFUI\ConstantContact\DateTime',
28+
'deleted_at' => '\PHPFUI\ConstantContact\Date',
29+
'sms_channel' => '\PHPFUI\ConstantContact\Definition\TrackingActivitySmsChannelDTO',
30+
31+
];
32+
}
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
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\PContactClickTrackingActivity> $tracking_activities The list of landing page contact click tracking activities.
9+
* @property \PHPFUI\ConstantContact\Definition\Links2 $_links HAL property that contains next link if applicable
10+
*/
11+
class PContactClickTrackingActivitiesPage extends \PHPFUI\ConstantContact\Definition\Base
12+
{
13+
protected static array $fields = [
14+
'tracking_activities' => 'array<\PHPFUI\ConstantContact\Definition\PContactClickTrackingActivity>',
15+
'_links' => '\PHPFUI\ConstantContact\Definition\Links2',
16+
17+
];
18+
}

0 commit comments

Comments
 (0)