CustomersApi
extends CustomerApiBase
in package
Uses
DeleteInIdList
V3ApiBase
Add constructors and some basic scaffolding that will work for all API classes regardless of which endpoints they implement
Tags
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
- delete() : bool
- formFieldValues() : CustomerFormFieldValuesApi
- getAll() : CustomersResponse
- getAllPages() : CustomersResponse
- getByEmail() : Customer|null
- getById() : Customer|null
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
- getStoredInstruments() : StoredInstrumentsResponse
- multipleResourceUrl() : string
- settings() : CustomerSettingsApi
- subscriber() : SubscribersApi
- subscribers() : SubscribersApi
- update() : CustomersResponse
- validateCredentials() : ValidateCredentialsResponse
Constants
FILTER__EMAIL_IN
public
mixed
FILTER__EMAIL_IN
= 'email:in'
Tags
FILTER__ID_IN
public
mixed
FILTER__ID_IN
= 'id:in'
Tags
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
Tags
Return values
mixed —addresses()
public
addresses() : CustomerAddressesApi
Tags
Return values
CustomerAddressesApi —attributes()
public
attributes() : CustomerAttributesApi
Tags
Return values
CustomerAttributesApi —attributeValues()
public
attributeValues() : CustomerAttributeValuesApi
Tags
Return values
CustomerAttributeValuesApi —consent()
public
consent() : CustomerConsentApi
Tags
Return values
CustomerConsentApi —create()
public
create(array<string|int, mixed> $customers) : CustomersResponse
Parameters
- $customers : array<string|int, mixed>
Tags
Return values
CustomersResponse —delete()
public
delete([array<string|int, mixed> $ids = [] ]) : bool
Parameters
- $ids : array<string|int, mixed> = []
Tags
Return values
bool —formFieldValues()
public
formFieldValues() : CustomerFormFieldValuesApi
Tags
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
Tags
Return values
CustomersResponse —getAllPages()
public
getAllPages([array<string|int, mixed> $filter = [] ]) : CustomersResponse
Parameters
- $filter : array<string|int, mixed> = []
Tags
Return values
CustomersResponse —getByEmail()
public
getByEmail(string $email) : Customer|null
Parameters
- $email : string
Tags
Return values
Customer|null —getById()
public
getById(int $id) : Customer|null
Parameters
- $id : int
Tags
Return values
Customer|null —getClient()
public
getClient() : Client
Tags
Return values
Client —getParentResourceId()
public
getParentResourceId() : int|null
Tags
Return values
int|null —getResourceId()
public
getResourceId() : int|null
Tags
Return values
int|null —getStoredInstruments()
public
getStoredInstruments() : StoredInstrumentsResponse
Tags
Return values
StoredInstrumentsResponse —multipleResourceUrl()
public
abstract multipleResourceUrl() : string
Tags
Return values
string —settings()
public
settings() : CustomerSettingsApi
Tags
Return values
CustomerSettingsApi —subscriber()
public
subscriber(int $id) : SubscribersApi
Parameters
- $id : int
Tags
Return values
SubscribersApi —subscribers()
public
subscribers() : SubscribersApi
Tags
Return values
SubscribersApi —update()
public
update(array<string|int, mixed> $customers) : CustomersResponse
Parameters
- $customers : array<string|int, mixed>
Tags
Return values
CustomersResponse —validateCredentials()
public
validateCredentials(string $email, string $password[, int|null $channel_id = null ]) : ValidateCredentialsResponse
Parameters
- $email : string
- $password : string
- $channel_id : int|null = null