Copied!
CloneableInstantiable
Methods
public __construct(PHPFUI\ConstantContact\Client $client)
public get(?string $offset = NULL, ?string $limit = NULL, ?string $account_type = NULL) : array
 

GET Partner Client Accounts

Get all Constant Contact client accounts managed under your technology
partner account. Use the limit query parameter to set the number of
accounts to return on each results page. Use the account_type query
parameter to filter client account results by type: all (default),
managed, or unmanaged.
Only technology partners can access partner endpoints and partner endpoints
cannot be tested using the API reference tester.
For more use case information, see Get all Partner Client Accounts
in the API guide.

  • param string $offset Depending on the limit you specify, the system determines the offset parameter to use (number of records to skip) and includes it in the link used to get the next page of results
  • param string $limit The number of client accounts to return on each page of results. The default value is 50. Entering a limit value less than the minimum (10) or greater than the maximum (50) is ignored and the system uses the default values. Depending on the limit you specify, the system determines the offset parameter to use (number of records to skip) and includes it in the link used to get the next page of results.
  • param string $account_type Filters client account results by account type: all (default), managed, or unmanaged. Excluding the account_type query parameter returns all client accounts for the partner.
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 post(PHPFUI\ConstantContact\Definition\Provision $provision) : array
 

POST (create) a Partner Client Account

Use this POST method to create a new Constant Contact client account
under your partner account, set up the billing plan for the account,
and to add the new client to the default contact list.

Newly created accounts are free trials which give the user up to 60
days to try Constant Contact before buying. Trial accounts have limits
depending on the services that are included.

If a field validation error occurs, a 400 response message is returned.

If provisioning does not complete successfully due to unavailable dependencies,
such as database or dependent services, a 503 response message is returned.
By default, the client account provision data is stored and processed
when provisioning becomes available.

Some client account features will be supported in future releases, such
as Single Sign On (SSO).

For more use case information, see Create a new Partner Client Account
in the API guide.

  • param \PHPFUI\ConstantContact\Definition\Provision $provision Create a new Constant Contact client account under your partner account. All required properties must be included in the JSON payload request.
public PHPFUI\ConstantContact\Base::success() : bool
Properties
protected PHPFUI\ConstantContact\Client PHPFUI\ConstantContact\Base::$client
protected string PHPFUI\ConstantContact\Base::$urlPath
Methods
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
© 2023 Bruce Wells
Search Namespaces \ Classes
Configuration