PHPFUI/InstaDoc
 
Copied!
  • property \PHPFUI\ConstantContact\UUID[] $contact_ids Exports up to 500 specific contacts. This property is mutually exclusive with list_ids.
  • property \PHPFUI\ConstantContact\UUID[] $list_ids Exports all of the contacts inside of up to 50 contact lists. This property is mutually exclusive with contact_ids.
  • property int $segment_id Specify the segment_id from which you want to export all contacts that meet the specified segment_criteria. This property is mutually exclusive with contact_ids and list_ids. You can only specify one segment_id.
  • property array $fields Use this array to export specific contact fields. You must export email_address to successfully export email_optin_source, email_optin_date, email_optout_source, email_optout_date, or email_optout_reason.
  • property string $status Allows you to export only contacts that have a specific status value. Possible values are active, unsubscribed, or removed
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, ?mixed $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 = ['contact_ids' => 'array<\PHPFUI\ConstantContact\UUID>', 'list_ids' => 'array<\PHPFUI\ConstantContact\UUID>', 'segment_id' => 'int', 'fields' => 'array', 'status' => 'string']
protected static array $maxLength = ['contact_ids' => 500, 'list_ids' => 50]
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 = ['contact_ids' => 'array<\PHPFUI\ConstantContact\UUID>', 'list_ids' => 'array<\PHPFUI\ConstantContact\UUID>', 'segment_id' => 'int', 'fields' => 'array', 'status' => 'string']
protected static array $maxLength = ['contact_ids' => 500, 'list_ids' => 50]
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.
© 2024 Bruce Wells
Search Namespaces \ Classes
Configuration