WishlistsApi
extends V3ApiBase
in package
Uses
GetResource, GetAllResources, UpdateResource, CreateResource, DeleteResource
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_CUSTOMER_ID = 'customer_id'
- __construct() : mixed
- create() : WishlistResponse
- delete() : ResponseInterface
- get() : WishlistResponse
- getAll() : WishlistsResponse
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
- multipleResourceUrl() : string
- singleResourceUrl() : string
- update() : WishlistResponse
Constants
FILTER_CUSTOMER_ID
public
mixed
FILTER_CUSTOMER_ID
= 'customer_id'
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 —create()
public
create(Wishlist $wishlist) : WishlistResponse
Parameters
- $wishlist : Wishlist
Tags
Return values
WishlistResponse —delete()
public
delete() : ResponseInterface
Tags
Return values
ResponseInterface —get()
public
get() : WishlistResponse
Tags
Return values
WishlistResponse —getAll()
public
getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : WishlistsResponse
Parameters
- $filters : array<string|int, mixed> = []
- $page : int = 1
- $limit : int = 250
Tags
Return values
WishlistsResponse —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
multipleResourceUrl() : string
Tags
Return values
string —singleResourceUrl()
public
singleResourceUrl() : string
Tags
Return values
string —update()
public
update(Wishlist $wishlist) : WishlistResponse
Parameters
- $wishlist : Wishlist