public __construct(PHPFUI\ConstantContact\Client $client)
public delete(string $list_id) : bool


Deletes the specified contact list and its membership. DELETE List requests are processed asynchronously, and you can track the status of the request by making a GET call to the URI shown in the _links property in the response.

  • param string $list_id Unique ID of the list to delete
public get(string $list_id, ?string $include_membership_count = NULL) : array

GET a List

Use this method to get details about a specific contact list (list_id).

  • param string $list_id The system generated ID that uniquely identifies a contact list.
  • param string $include_membership_count Returns the total number of contacts per list that meet your selection criteria. Set the include_membership_count to active, to count only active contacts, or all to include all contacts in the count.
public PHPFUI\ConstantContact\Base::getLastError() : string
public PHPFUI\ConstantContact\Base::getResponseText() : string
public PHPFUI\ConstantContact\Base::getStatusCode() : int
public PHPFUI\ConstantContact\Base::next() : array

If the endpoint is paginated, you can call next() to retrieve the next set of data. If no next is provided, an empty array is returned.

  • return array filled with next part of the response from the endpoint, or empty if no next.
public put(string $list_id, PHPFUI\ConstantContact\Definition\ListInput $JSON_PUT_body) : array

PUT (update) a List

Updates an existing contact list resource, specified by list_id

  • param string $list_id Unique ID of the contact list to update
  • param \PHPFUI\ConstantContact\Definition\ListInput $JSON_PUT_body JSON payload containing updates to the specified contact list
public PHPFUI\ConstantContact\Base::success() : bool
protected PHPFUI\ConstantContact\Client PHPFUI\ConstantContact\Base::$client
protected string PHPFUI\ConstantContact\Base::$urlPath
protected PHPFUI\ConstantContact\Base::doDelete(array $parameters) : bool
protected PHPFUI\ConstantContact\Base::doGet(array $parameters) : array
protected PHPFUI\ConstantContact\Base::doPatch(array $parameters) : array
protected PHPFUI\ConstantContact\Base::doPost(array $parameters) : array
protected PHPFUI\ConstantContact\Base::doPut(array $parameters) : array
© 2024 Bruce Wells
Search Namespaces \ Classes