| 1 | <?php | ||
| 5 | class ContactsList extends Resource | ||
| 6 | { | ||
| 7 | /** | ||
| 8 | * The id of the list. | ||
| 9 | * | ||
| 10 | * @var string | ||
| 11 | */ | ||
| 12 | public $id; | ||
| 13 | |||
| 14 | /** | ||
| 15 | * Name of the list. | ||
| 16 | * | ||
| 17 | * @var string | ||
| 18 | */ | ||
| 19 | public $name; | ||
| 20 | |||
| 21 | /** | ||
| 22 | * URL-safe list name. Example: 'list-name-sample'. | ||
| 23 | * | ||
| 24 | * @var string | ||
| 25 | */ | ||
| 26 | public $stringid; | ||
| 27 | |||
| 28 | /** | ||
| 29 | * The website URL this list is for. | ||
| 30 | * | ||
| 31 | * @var string | ||
| 32 | */ | ||
| 33 | public $senderUrl; | ||
| 34 | |||
| 35 | /** | ||
| 36 | * A reminder for your contacts as to why they are on this list and you are messaging them. | ||
| 37 | * For example: 'You signed up for my mailing list.'. | ||
| 38 | * | ||
| 39 | * @var string | ||
| 40 | */ | ||
| 41 | public $senderReminder; | ||
| 42 | |||
| 43 | /** | ||
| 44 | * Boolean value indicating whether or not to send the last sent campaign to this list to a | ||
| 45 | * new subscriber upon subscribing. 1 = yes, 0 = no. | ||
| 46 | * | ||
| 47 | * @var bool | ||
| 48 | */ | ||
| 49 | public $sendLastBroadcast; | ||
| 50 | |||
| 51 | /** | ||
| 52 | * Comma-separated list of email addresses to send a copy of all mailings to upon send. | ||
| 53 | * | ||
| 54 | * @var string | ||
| 55 | */ | ||
| 56 | public $carboncopy; | ||
| 57 | |||
| 58 | /** | ||
| 59 | * Comma-separated list of email addresses to notify when a new subscriber joins this list. | ||
| 60 | * | ||
| 61 | * @var string | ||
| 62 | */ | ||
| 63 | public $subscriptionNotify; | ||
| 64 | |||
| 65 | /** | ||
| 66 | * Comma-separated list of email addresses to notify when a subscriber unsubscribes from this list. | ||
| 67 | * | ||
| 68 | * @var string | ||
| 69 | */ | ||
| 70 | public $unsubscriptionNotify; | ||
| 71 | |||
| 72 | /** | ||
| 73 | * User Id of the list owner. A list owner is able to control campaign branding. | ||
| 74 | * A property of list.userid also exists on this object; both properties map to the same list owner | ||
| 75 | * field and are being maintained in the response object for backward compatibility. If you post values | ||
| 76 | * for both list.user and list.userid, the value of list.user will be used. | ||
| 77 | * | ||
| 78 | * @var int | ||
| 79 | */ | ||
| 80 | public $user; | ||
| 81 | |||
| 82 | /** | ||
| 83 | * Get all contacts related to the list. | ||
| 84 | * | ||
| 85 | * @return Contact[] | ||
| 86 | */ | ||
| 87 | public function contacts() | ||
| 91 | } | ||
| 92 |