PHPFUI/InstaDoc

Methods

public __construct(PHPFUI\ConstantContact\Client $client)

public delete(string $campaign_activity_id) : bool

DELETE an A/B Test for an Email Campaign Activity

Deletes an A/B Test on an primary email campaign activity. You can only
delete A/B tests that have a current_status of Draft. Deleting an
A/B tests reverts the email campaign activity type from A/B Test (code=
57) back to NewsLetter (code= 10). Constant Contact uses the original
subject line, rather than the alternate A/B test subject line, when
an A/B test is deleted.

param phpDocumentor\Reflection\Types\String_ $campaign_activity_id The unique ID for the primary email campaign activity.

public get(string $campaign_activity_id) : array

GET A/B Test Details for an Email Campaign Activity

Use this method to get A/B test details for a primary email campaign
activity, such as the alternate email subject line, the contact test
percentage size, and the number of hours to wait to determine the winning
subject line to use. Currently, A/B tests support subject line only.

param phpDocumentor\Reflection\Types\String_ $campaign_activity_id The unique ID for the primary email campaign activity.

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 phpDocumentor\Reflection\Types\Array_ filled with next part of the response from the endpoint, or empty if no next.

public post(string $campaign_activity_id, PHPFUI\ConstantContact\Definition\ABTestData $abtest) : array

POST (Create) an A/B Test for an Email Campaign Activity

Use this method to create a new A/B test for a primary email campaign
activity. You must specify an alternative subject line, the percentage
of contact to use for the A/B test, and the number of hours to wait
after the A/B test is sent before determining the winning subject line.
To create an A/B test, the campaign must have a current_status of
DRAFT. When you create an A/B test, the type changes from Newsletter
(code= 10) to A/B Test (code= 57).

param phpDocumentor\Reflection\Types\String_ $campaign_activity_id The unique ID for the primary email campaign activity.
param phpDocumentor\Reflection\Types\Object_ $abtest Specify the alternative_subject line, test_size percentage of contacts (value must from 5 to 50 inclusively), and the winner_wait_duration (value must be 6, 12, 24, or 48 hours).

public PHPFUI\ConstantContact\Base::success() : bool