ChannelsApi extends ResourceApiNoDelete
V3ApiBase
Add constructors and some basic scaffolding that will work for all API classes regardless of which endpoints they implement
Table of Contents
- INCLUDE__CURRENCIES = 'currencies'
- __construct() : mixed
- create() : ChannelResponse
- currencyAssignments() : ChannelCurrencyAssignmentsApi
- delete() : ResponseInterface
- get() : ChannelResponse
- getActiveTheme() : ChannelActiveThemeResponse
- getAll() : ChannelsResponse
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
- listing() : ChannelListingsApi
- listings() : ChannelListingsApi
- site() : ChannelSitesApi
- update() : ChannelResponse
Constants
INCLUDE__CURRENCIES
public
mixed
INCLUDE__CURRENCIES
= 'currencies'
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 —create()
public
create(Channel $channel) : ChannelResponse
Parameters
- $channel : Channel
Return values
ChannelResponse —currencyAssignments()
public
currencyAssignments() : ChannelCurrencyAssignmentsApi
Return values
ChannelCurrencyAssignmentsApi —delete()
public
delete() : ResponseInterface
Return values
ResponseInterface —get()
public
get([string|null $include = null ]) : ChannelResponse
Parameters
- $include : string|null = null
Return values
ChannelResponse —getActiveTheme()
public
getActiveTheme() : ChannelActiveThemeResponse
Return values
ChannelActiveThemeResponse —getAll()
public
getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : ChannelsResponse
Parameters
- $filters : array<string|int, mixed> = []
- $page : int = 1
- $limit : int = 250
Return values
ChannelsResponse —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 —listing()
public
listing(int $id) : ChannelListingsApi
Parameters
- $id : int
Return values
ChannelListingsApi —listings()
public
listings() : ChannelListingsApi
Return values
ChannelListingsApi —site()
public
site() : ChannelSitesApi
Return values
ChannelSitesApi —update()
public
update(Channel $channel) : ChannelResponse
Parameters
- $channel : Channel