PHPFUI/InstaDoc
 
Copied!
  • property \PHPFUI\ConstantContact\Definition\ActivityReference[] $campaign_activities Lists the role and unique activity ID of each campaign activity that is associated with an Email Campaign.
  • property string $campaign_id The unique ID used to identify the email campaign (UUID format).
  • property \PHPFUI\ConstantContact\DateTime $created_at The system generated date and time that this email campaign was created. This string is readonly and is in ISO-8601 format.
  • property string $current_status The current status of the email campaign. Valid values are:

    • Draft — An email campaign that you have created but have not sent to contacts.

    • Scheduled — An email campaign that you have scheduled for Constant Contact to send to contacts.

    • Executing — An email campaign that Constant Contact is currently sending to contacts. Email campaign activities are only in this status briefly.

    • Done — An email campaign that you successfully sent to contacts.

    • Error — An email campaign activity that encountered an error.

    • Removed — An email campaign that a user deleted. Users can view and restore deleted emails through the UI.
      • *
  • property string $name The descriptive name the user provides to identify this campaign. Campaign names must be unique for each account ID.
  • property string $type Identifies the type of campaign that you select when creating the campaign. Newsletter and Custom Code email campaigns are the primary types.
  • property int $type_code The code used to identify the email campaign type.

    • 1 (Default)

    • 2 (Bulk Email)

    • 10 (Newsletter)

    • 11 (Announcement)

    • 12 (Product/Service News)

    • 14 (Business Letter)

    • 15 (Card)

    • 16 (Press release)

    • 17 (Flyer)

    • 18 (Feedback Request)

    • 19 (Ratings and Reviews)

    • 20 (Event Announcement)

    • 21 (Simple Coupon)

    • 22 (Sale Promotion)

    • 23 (Product Promotion)

    • 24 (Membership Drive)

    • 25 (Fundraiser)

    • 26 (Custom Code Email)

    • 57 (A/B Test)
      • *
  • property \PHPFUI\ConstantContact\DateTime $updated_at The system generated date and time showing when the campaign was last updated. This string is read only and is in ISO-8601 format.
CloneableInstantiable
Methods
public PHPFUI\ConstantContact\Definition\Base::__construct(array $initialValues = [])
public PHPFUI\ConstantContact\Definition\Base::__get(string $field) : ?mixed
 

Unset fields will return null

public PHPFUI\ConstantContact\Definition\Base::__set(string $field, $value)
 
  • return mixed value being set to allow for assignment chaining
public PHPFUI\ConstantContact\Definition\Base::getData() : array
 
  • return array representation of data
public PHPFUI\ConstantContact\Definition\Base::getfields() : array
 
  • return array all the valid fields for the object. Index is field name and value is the type.
public PHPFUI\ConstantContact\Definition\Base::getJSON() : string
 
  • return string pretty print JSON
Properties
protected static array $fields = ['campaign_activities' => 'array<\PHPFUI\ConstantContact\Definition\ActivityReference>', 'campaign_id' => 'string', 'created_at' => '\PHPFUI\ConstantContact\DateTime', 'current_status' => ['Draft', 'Scheduled', 'Executing', 'Done', 'Removed', 'Error'], 'name' => 'string', 'type' => ['Newsletter', 'Custom Code Email', 'Announcement', 'Product/Service News', 'Business Letter', 'Card', 'Press release', 'Flyer', 'Feedback Request', 'Ratings and Reviews', 'Event Announcement', 'Simple Coupon', 'Sale Promotion', 'Product Promotion', 'Membership Drive', 'Fundraiser'], 'type_code' => 'int', 'updated_at' => '\PHPFUI\ConstantContact\DateTime']
protected static array $maxLength = ['name' => 80]
protected static array PHPFUI\ConstantContact\Definition\Base::$minLength = []
 
  • var array<string,int> minimum allowed values. Arrays are size, int and float are values, strings are length.
protected static array PHPFUI\ConstantContact\Definition\Base::$requiredFields = []
 
  • var string[] required fields.
Properties
protected static array $fields = ['campaign_activities' => 'array<\PHPFUI\ConstantContact\Definition\ActivityReference>', 'campaign_id' => 'string', 'created_at' => '\PHPFUI\ConstantContact\DateTime', 'current_status' => ['Draft', 'Scheduled', 'Executing', 'Done', 'Removed', 'Error'], 'name' => 'string', 'type' => ['Newsletter', 'Custom Code Email', 'Announcement', 'Product/Service News', 'Business Letter', 'Card', 'Press release', 'Flyer', 'Feedback Request', 'Ratings and Reviews', 'Event Announcement', 'Simple Coupon', 'Sale Promotion', 'Product Promotion', 'Membership Drive', 'Fundraiser'], 'type_code' => 'int', 'updated_at' => '\PHPFUI\ConstantContact\DateTime']
protected static array $maxLength = ['name' => 80]
protected static array PHPFUI\ConstantContact\Definition\Base::$minLength = []
 
  • var array<string,int> minimum allowed values. Arrays are size, int and float are values, strings are length.
protected static array PHPFUI\ConstantContact\Definition\Base::$requiredFields = []
 
  • var string[] required fields.
© 2023 Bruce Wells
Search Namespaces \ Classes
Configuration