CustomersApi extends CustomerApiBase
V3ApiBase
Add constructors and some basic scaffolding that will work for all API classes regardless of which endpoints they implement
Table of Contents
- FILTER__EMAIL_IN = 'email:in'
- FILTER__ID_IN = 'id:in'
- __construct() : mixed
- addresses() : CustomerAddressesApi
- attributes() : CustomerAttributesApi
- attributeValues() : CustomerAttributeValuesApi
- consent() : CustomerConsentApi
- create() : CustomersResponse
- formFieldValues() : CustomerFormFieldValuesApi
- getAll() : CustomersResponse
- getAllPages() : CustomersResponse
- getByEmail() : Customer|null
- getById() : Customer|null
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
- subscriber() : SubscribersApi
- subscribers() : SubscribersApi
- update() : CustomersResponse
Constants
FILTER__EMAIL_IN
public
mixed
FILTER__EMAIL_IN
= 'email:in'
FILTER__ID_IN
public
mixed
FILTER__ID_IN
= 'id:in'
Methods
__construct()
public
__construct(Client $client[, int|null $resourceId = null ][, int|null $parentResourceId = null ]) : mixed
Parameters
- $client : Client
- $resourceId : int|null = null
- $parentResourceId : int|null = null
Return values
mixed —addresses()
public
addresses() : CustomerAddressesApi
Return values
CustomerAddressesApi —attributes()
public
attributes() : CustomerAttributesApi
Return values
CustomerAttributesApi —attributeValues()
public
attributeValues() : CustomerAttributeValuesApi
Return values
CustomerAttributeValuesApi —consent()
public
consent() : CustomerConsentApi
Return values
CustomerConsentApi —create()
public
create(array<string|int, mixed> $customers) : CustomersResponse
Parameters
- $customers : array<string|int, mixed>
Return values
CustomersResponse —formFieldValues()
public
formFieldValues() : CustomerFormFieldValuesApi
Return values
CustomerFormFieldValuesApi —getAll()
public
getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : CustomersResponse
Parameters
- $filters : array<string|int, mixed> = []
- $page : int = 1
- $limit : int = 250
Return values
CustomersResponse —getAllPages()
public
getAllPages([array<string|int, mixed> $filter = [] ]) : CustomersResponse
Parameters
- $filter : array<string|int, mixed> = []
Return values
CustomersResponse —getByEmail()
public
getByEmail(string $email) : Customer|null
Parameters
- $email : string
Return values
Customer|null —getById()
public
getById(int $id) : Customer|null
Parameters
- $id : int
Return values
Customer|null —getClient()
public
getClient() : Client
Return values
Client —getParentResourceId()
public
getParentResourceId() : int|null
Return values
int|null —getResourceId()
public
getResourceId() : int|null
Return values
int|null —subscriber()
public
subscriber(int $id) : SubscribersApi
Parameters
- $id : int
Return values
SubscribersApi —subscribers()
public
subscribers() : SubscribersApi
Return values
SubscribersApi —update()
public
update(array<string|int, mixed> $customers) : CustomersResponse
Parameters
- $customers : array<string|int, mixed>