Index | Klaviyo PHP API Library

A

ApiConnectionException — Class in namespace Klaviyo\Exception: Simple Exception for Klaviyo API.
ApiException — Class in namespace Klaviyo\Exception: Simple Exception for Klaviyo API.
ListService::addPersonToList() — Method in class ListService: Add a person to an existing List.

B

BaseService — Class in namespace Klaviyo: The base manager class used handle models transmission to and from the API.
BadRequestApiException — Class in namespace Klaviyo\Exception: Simple Exception for Klaviyo API.
BaseModel — Class in namespace Klaviyo\Model: The base Klaviyo data model.

C

BaseService::create() — Method in class BaseService: Instantiates a new instance of this class.
CampaignService — Class in namespace Klaviyo: The campaign manager class used to handle campaigns.
CampaignService::createCampaign() — Method in class CampaignService: Create a new campaign.
CannotDeleteRequiredSpecialAttributeKeyException — Class in namespace Klaviyo\Exception: Simple Exception for Klaviyo API.
KlaviyoApi::create() — Method in class KlaviyoApi: Helper method for creating a new API object.
KlaviyoFacade::create() — Method in class KlaviyoFacade: Factory method to create a new service continer.
ListService::createList() — Method in class ListService: Create a new list.
ListService::checkMembersAreInList() — Method in class ListService: Check if the specified members are in the list by email address.
ListService::checkMembersAreInSegment() — Method in class ListService: Check if the specified members are in the segment by email address.
BaseModel::create() — Method in class BaseModel: Helper method to create the data model.
BaseModel::createFromJson() — Method in class BaseModel: Helper method to create the data model from a JSON array.
CampaignModel — Class in namespace Klaviyo\Model: Simple model that represents a campaign.
ModelFactory::create() — Method in class ModelFactory: Create a new model.
ModelFactory::createFromJson() — Method in class ModelFactory: Create a new model from JSON.
ModelFactory::callModelCreationMethod() — Method in class ModelFactory: Create a new model from using the specified method.
ModelInterface::create() — Method in class ModelInterface: Helper method to create the data model.
ModelInterface::createFromJson() — Method in class ModelInterface: Helper method to create the data model from a JSON array.
PersonModel::createFromJson() — Method in class PersonModel: Helper method to create the data model from a JSON array.
ServiceInterface::create() — Method in class ServiceInterface: Instantiates a new instance of this class.

D

$KlaviyoApi — Property in class KlaviyoApi
ListService::deleteList() — Method in class ListService: Delete an existing list.
PersonModel::deleteAttribute() — Method in class PersonModel: Delete an attribute from the person model.

E

$KlaviyoApi — Property in class KlaviyoApi
EmptyModel — Class in namespace Klaviyo\Model: The empty Klaviyo data model.

G

BaseService::getResourcePath() — Method in class BaseService: Retrieve the full resource path.
CampaignService::getCampaign() — Method in class CampaignService: Retrieve a specific campaign from Klaviyo.
KlaviyoApi::getModelType() — Method in class KlaviyoApi: Retrieve the model type based on the percieved model type.
KlaviyoApi::getOption() — Method in class KlaviyoApi: Retrieve a specific option.
KlaviyoApi::getAllOptions() — Method in class KlaviyoApi: Retrieve an an array of all available options.
KlaviyoFacade::getContainer() — Method in class KlaviyoFacade: Retrieve the container.
KlaviyoFacade::getModelClass() — Method in class KlaviyoFacade: Retrieve the model class of the specified model.
ListService::getList() — Method in class ListService: Retrieve a specific list from Klaviyo.
ListService::getAllLists() — Method in class ListService: Retrieve all lists from Klaviyo.
ListService::getListsFromPage() — Method in class ListService: Get lists from a specific page.
ModelFactory::getModelMap() — Method in class ModelFactory: Retrieve the model map.
ModelFactory::getModelType() — Method in class ModelFactory: Get the model type.
PersonModel::getAttributeKeys() — Method in class PersonModel: Retrieve an array of all attribute keys.
PersonModel::getCustomAttribute() — Method in class PersonModel: Retrieve a custom attribute by its attribute key.
PersonModel::getAllCustomAttributes() — Method in class PersonModel: Retrieve all custom attributes for the person.
PersonModel::getModelPropertyFromSpecialAttributeKey() — Method in class PersonModel: Retrieve the model property from the special attribute key.
TemplateModel::getHtmlObjectFromString() — Method in class TemplateModel: Retrieve an HTML object from the specified string.
PagerTrait::getApi() — Method in class PagerTrait: Retrieve the KlaviyoApi service object.
PagerTrait::getAllRecords() — Method in class PagerTrait: Reteive all records for the specified paginated resource.
PagerTrait::getRecordsFromSpecificPage() — Method in class PagerTrait: Retrieve the records from a specific page.
PagerTrait::getPage() — Method in class PagerTrait: Retrieve a specific page from Klaviyo.
PersonService::getPerson() — Method in class PersonService: Retrieve a person from the Klaviyo API.
ServiceInterface::getResourcePath() — Method in class ServiceInterface: Retrieve the full resource path.

I

InvalidSpecialAttributeKeyException — Class in namespace Klaviyo\Exception: Simple Exception for Klaviyo API.
IsNotAServiceException — Class in namespace Klaviyo\Exception: Simple Exception for Klaviyo API.
PersonModel::isCustomAttributeKey() — Method in class PersonModel: Determine if the attribute is a custom attribute.
PersonModel::isSpecialAttributeKey() — Method in class PersonModel: Determine if the attribute is a special attribute.
TrackService::identify() — Method in class TrackService: Identify a person to the Klaviyo API.

J

BaseModel::jsonSerialize() — Method in class BaseModel: {@inheritdoc}
CampaignModel::jsonSerialize() — Method in class CampaignModel: {@inheritdoc}
ListModel::jsonSerialize() — Method in class ListModel: {@inheritdoc}
ListReferenceModel::jsonSerialize() — Method in class ListReferenceModel: {@inheritdoc}
MembershipModel::jsonSerialize() — Method in class MembershipModel: {@inheritdoc}
PageModel::jsonSerialize() — Method in class PageModel: {@inheritdoc}
PersonListModel::jsonSerialize() — Method in class PersonListModel: {@inheritdoc}
PersonModel::jsonSerialize() — Method in class PersonModel: {@inheritdoc}
PersonReferenceModel::jsonSerialize() — Method in class PersonReferenceModel: {@inheritdoc}
TemplateModel::jsonSerialize() — Method in class TemplateModel: {@inheritdoc}

K

KlaviyoExceptionInterface — Class in namespace Klaviyo\Exception: Simple Exception interface all Klavio exceptions should implement.
KlaviyoApi — Class in namespace Klaviyo: The main Klaviyo API class for communicating with the Klaviyo API.
KlaviyoFacade — Class in namespace Klaviyo: The Klaviyo API service container, model, and api wrapper.
KlaviyoProvider — Class in namespace Klaviyo: The Klaviyo api service container.

L

ListService — Class in namespace Klaviyo: The list manager class used to handle lists.
ListModel — Class in namespace Klaviyo\Model: Simple model for a Klaviyo "List".
ListReferenceModel — Class in namespace Klaviyo\Model: Simple model for a Klaviyo "List" reference.

M

MissingModelTypeException — Class in namespace Klaviyo\Exception: Simple Exception for Klaviyo API.
KlaviyoFacade::model() — Method in class KlaviyoFacade: The model factory wrapper method.
KlaviyoFacade::modelFromJson() — Method in class KlaviyoFacade: The create from json model factory wrapper method.
MembershipModel — Class in namespace Klaviyo\Model: Simple model for a Klaviyo "Membership".
ModelFactory — Class in namespace Klaviyo\Model: Model creation factory.
ModelInterface — Class in namespace Klaviyo\Model: The base Klaviyo data model.

N

NotAuthorizedApiException — Class in namespace Klaviyo\Exception: Simple Exception for Klaviyo API.
NotFoundApiException — Class in namespace Klaviyo\Exception: Simple Exception for Klaviyo API.

P

KlaviyoApi::prepareRequestOptions() — Method in class KlaviyoApi: Prepare the options array before use in the request.
PageModel — Class in namespace Klaviyo\Model: Simple model that represents a page.
PersonListModel — Class in namespace Klaviyo\Model: Simple model for a Klaviyo "Person and List".
PersonModel — Class in namespace Klaviyo\Model: Simple model for a Klaviyo "Person".
PersonReferenceModel — Class in namespace Klaviyo\Model: Simple model for a Klaviyo "Person" reference.
PagerTrait — Class in namespace Klaviyo: Trait for adding a pager to a class.
PersonService — Class in namespace Klaviyo: The list manager class used to handle lists.

R

KlaviyoApi::request() — Method in class KlaviyoApi: Perform a request against the API.
KlaviyoProvider::register() — Method in class KlaviyoProvider: {@inheritdoc}

S

CampaignService::sendCampaignImmediately() — Method in class CampaignService: Send a campaign immediately.
CampaignService::scheduleCampaign() — Method in class CampaignService: Schedule a campaign for a time in the future.
ServerErrorApiException — Class in namespace Klaviyo\Exception: Simple Exception for Klaviyo API.
ServiceNotFoundException — Class in namespace Klaviyo\Exception: Simple Exception for Klaviyo API.
KlaviyoApi::setOption() — Method in class KlaviyoApi: Set a specific option.
KlaviyoFacade::service() — Method in class KlaviyoFacade: Retrieve a service from the service container.
TemplateModel::setHtml() — Method in class TemplateModel: Set the html value.
ServiceInterface — Class in namespace Klaviyo: The base manager class used handle models transmission to and from the API.

T

BaseModel::toArray() — Method in class BaseModel: Convert the model to an array.
MembershipModel::toArray() — Method in class MembershipModel: Convert the model to an array.
ModelInterface::toArray() — Method in class ModelInterface: Convert the model to an array.
PersonModel::toArray() — Method in class PersonModel: Convert the model to an array.
TemplateModel — Class in namespace Klaviyo\Model: Simple model that represents a template.
TemplateService — Class in namespace Klaviyo: The template manager class used to handle templates.
TrackService — Class in namespace Klaviyo: The track manager class used to handle lists.

U

ListService::updateList() — Method in class ListService: Update/Modify an existing list.
PersonModel::updateFromArray() — Method in class PersonModel: Update the person model from an array.
TemplateService::updateTemplate() — Method in class TemplateService: Update the specified template.

_

BaseService::__construct() — Method in class BaseService: The constructor for the list manager class.
KlaviyoApi::__construct() — Method in class KlaviyoApi: The constructor for KlaviyoApi.
KlaviyoFacade::__construct() — Method in class KlaviyoFacade: The service container constructor.
KlaviyoProvider::__construct() — Method in class KlaviyoProvider: Provider constructor.
BaseModel::__construct() — Method in class BaseModel: The constructor of a Klaviyo data model.
BaseModel::__get() — Method in class BaseModel: PHPs magic get method to provide access to our protected attributes.
BaseModel::__set() — Method in class BaseModel: PHPs magic set method to provide access to our mutable attributes.
CampaignModel::__construct() — Method in class CampaignModel: The constructor of a Klaviyo data model.
ListModel::__construct() — Method in class ListModel: The constructor of a Klaviyo data model.
ListReferenceModel::__construct() — Method in class ListReferenceModel: The constructor of a Klaviyo data model.
MembershipModel::__construct() — Method in class MembershipModel: The constructor of a Klaviyo data model.
PageModel::__construct() — Method in class PageModel: The configuration to use to populate the Page model.
PersonListModel::__construct() — Method in class PersonListModel: The constructor of a Klaviyo data model.
PersonModel::__construct() — Method in class PersonModel: The constructor of a Klaviyo data model.
PersonReferenceModel::__construct() — Method in class PersonReferenceModel: The constructor of a Klaviyo data model.
TemplateModel::__construct() — Method in class TemplateModel: The constructor of a Klaviyo data model.
TemplateModel::__set() — Method in class TemplateModel: PHPs magic set method to provide access to our mutable attributes.