CustomerAttributesApi
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
- __construct() : mixed
- create() : CustomerAttributesResponse
- delete() : bool
- getAll() : CustomerAttributesResponse
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
- multipleResourceUrl() : string
- update() : CustomerAttributesResponse
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 —create()
public
create(array<string|int, mixed> $attributes) : CustomerAttributesResponse
Parameters
- $attributes : array<string|int, mixed>
Tags
Return values
CustomerAttributesResponse —delete()
public
delete([array<string|int, mixed> $ids = [] ]) : bool
Parameters
- $ids : array<string|int, mixed> = []
Tags
Return values
bool —getAll()
public
getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : CustomerAttributesResponse
Parameters
- $filters : array<string|int, mixed> = []
- $page : int = 1
- $limit : int = 250
Tags
Return values
CustomerAttributesResponse —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 —multipleResourceUrl()
public
abstract multipleResourceUrl() : string
Tags
Return values
string —update()
public
update(array<string|int, mixed> $attributes) : CustomerAttributesResponse
Parameters
- $attributes : array<string|int, mixed>