Skip to content

Add Subscriber API functions #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 14, 2023
Merged

Add Subscriber API functions #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
45830ea
Started stubbing missing subscriber functions
n7studios Mar 13, 2023
7b086c8
Coding standards
n7studios Mar 13, 2023
799ac86
Added tests
n7studios Mar 13, 2023
9e61ac0
Remove form_unsubscribe() test, as we now have specific unsubscribe()…
n7studios Mar 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
173 changes: 123 additions & 50 deletions src/ConvertKit_API.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,34 @@ public function get_landing_pages()
return $this->get_resources('landing_pages');
}

/**
* Adds a subscriber to a form.
*
* @param integer $form_id Form ID.
* @param array<string, string> $options Array of user data (email, name).
*
* @throws \InvalidArgumentException If the provided arguments are not of the expected type.
*
* @return false|object
*/
public function form_subscribe(int $form_id, array $options)
{
if (!is_int($form_id)) {
throw new \InvalidArgumentException();
}
if (!is_array($options)) {
throw new \InvalidArgumentException();
}

// Add API Key to array of options.
$options['api_key'] = $this->api_key;

return $this->post(
sprintf('forms/%s/subscribe', $form_id),
$options
);
}

/**
* List subscriptions to a form
*
Expand Down Expand Up @@ -452,55 +480,6 @@ public function get_resources(string $resource)
return $this->resources[$resource];
}

/**
* Adds a subscriber to a form.
*
* @param integer $form_id Form ID.
* @param array<string, string> $options Array of user data (email, name).
*
* @throws \InvalidArgumentException If the provided arguments are not of the expected type.
*
* @return false|object
*/
public function form_subscribe(int $form_id, array $options)
{
if (!is_int($form_id)) {
throw new \InvalidArgumentException();
}
if (!is_array($options)) {
throw new \InvalidArgumentException();
}

// Add API Key to array of options.
$options['api_key'] = $this->api_key;

return $this->post(
sprintf('forms/%s/subscribe', $form_id),
$options
);
}

/**
* Remove subscription from a form
*
* @param array<string, string> $options Array of user data (email).
*
* @throws \InvalidArgumentException If the provided arguments are not of the expected type.
*
* @return false|object
*/
public function form_unsubscribe(array $options)
{
if (!is_array($options)) {
throw new \InvalidArgumentException();
}

// Add API Secret to array of options.
$options['api_secret'] = $this->api_secret;

return $this->put('unsubscribe', $options);
}

/**
* Get the ConvertKit subscriber ID associated with email address if it exists.
* Return false if subscriber not found.
Expand All @@ -524,7 +503,6 @@ public function get_subscriber_id(string $email_address)
'subscribers',
[
'api_secret' => $this->api_secret,
'status' => 'all',
'email_address' => $email_address,
]
);
Expand All @@ -548,6 +526,8 @@ public function get_subscriber_id(string $email_address)
*
* @param integer $subscriber_id Subscriber ID.
*
* @see https://developers.convertkit.com/#view-a-single-subscriber
*
* @throws \InvalidArgumentException If the provided arguments are not of the expected type.
*
* @return false|integer
Expand All @@ -566,11 +546,104 @@ public function get_subscriber(int $subscriber_id)
);
}

/**
* Updates the information for a single subscriber.
*
* @param integer $subscriber_id Existing Subscriber ID.
* @param string $first_name New First Name.
* @param string $email_address New Email Address.
* @param array<string, string> $fields Updated Custom Fields.
*
* @see https://developers.convertkit.com/#update-subscriber
*
* @return false|mixed
*/
public function update_subscriber(
int $subscriber_id,
string $first_name = '',
string $email_address = '',
array $fields = []
) {
// Build parameters.
$options = [
'api_secret' => $this->api_secret,
];

if (!empty($first_name)) {
$options['first_name'] = $first_name;
}
if (!empty($email_address)) {
$options['email_address'] = $email_address;
}
if (!empty($fields)) {
$options['fields'] = $fields;
}

// Send request.
return $this->put(
sprintf('subscribers/%s', $subscriber_id),
$options
);
}

/**
* Unsubscribe an email address from all forms and sequences.
*
* @param string $email Email Address.
*
* @see https://developers.convertkit.com/#unsubscribe-subscriber
*
* @return false|object
*/
public function unsubscribe(string $email)
{
return $this->put(
'unsubscribe',
[
'api_secret' => $this->api_secret,
'email' => $email,
]
);
}

/**
* Remove subscription from a form
*
* @param array<string, string> $options Array of user data (email).
*
* @see https://developers.convertkit.com/#unsubscribe-subscriber
*
* @throws \InvalidArgumentException If the provided arguments are not of the expected type.
*
* @return false|object
*/
public function form_unsubscribe(array $options)
{
// This function is deprecated in 1.0, as we prefer functions with structured arguments.
// This function name is also misleading, as it doesn't just unsubscribe the email
// address from forms.
trigger_error(
'form_unsubscribe() is deprecated in 1.0. Use unsubscribe($email) instead.',
E_USER_NOTICE
);

if (!is_array($options)) {
throw new \InvalidArgumentException();
}

// Add API Secret to array of options.
$options['api_secret'] = $this->api_secret;

return $this->put('unsubscribe', $options);
}

/**
* Get a list of the tags for a subscriber.
*
* @param integer $subscriber_id Subscriber ID.
*
* @see https://developers.convertkit.com/#list-tags-for-a-subscriber
*
* @throws \InvalidArgumentException If the provided arguments are not of the expected type.
*
* @return false|array<int,\stdClass>
Expand Down
Loading