CustomTemplateAssociationsApi extends V3ApiBase
V3ApiBase
Add constructors and some basic scaffolding that will work for all API classes regardless of which endpoints they implement
Table of Contents
- DELETE_QUERY_CHANNEL_ID = 'channel_id'
- DELETE_QUERY_ENTITY_ID_IN = 'entity_id:in'
- DELETE_QUERY_ID_IN = 'id:in'
- DELETE_QUERY_TYPE = 'type'
- FILTER_CHANNEL_ID = 'channel_id'
- FILTER_ENTITY_ID_IN = 'entity_id:in'
- FILTER_IS_VALID = 'is_valid'
- FILTER_TYPE = 'type'
- __construct() : mixed
- batchUpdate() : CustomTemplateAssociationsResponse
- delete() : void
- deleteByChannelId() : void
- deleteByEntityIds() : void
- deleteByIds() : void
- getAll() : CustomTemplateAssociationsResponse
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
- multipleResourcesEndpoint() : string
- multipleResourceUrl() : string
Constants
DELETE_QUERY_CHANNEL_ID
public
mixed
DELETE_QUERY_CHANNEL_ID
= 'channel_id'
DELETE_QUERY_ENTITY_ID_IN
public
mixed
DELETE_QUERY_ENTITY_ID_IN
= 'entity_id:in'
DELETE_QUERY_ID_IN
public
mixed
DELETE_QUERY_ID_IN
= 'id:in'
DELETE_QUERY_TYPE
public
mixed
DELETE_QUERY_TYPE
= 'type'
FILTER_CHANNEL_ID
public
mixed
FILTER_CHANNEL_ID
= 'channel_id'
FILTER_ENTITY_ID_IN
public
mixed
FILTER_ENTITY_ID_IN
= 'entity_id:in'
FILTER_IS_VALID
public
mixed
FILTER_IS_VALID
= 'is_valid'
FILTER_TYPE
public
mixed
FILTER_TYPE
= 'type'
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 —batchUpdate()
public
batchUpdate(array<string|int, CustomTemplateAssociation> $templateAssociations) : CustomTemplateAssociationsResponse
Parameters
- $templateAssociations : array<string|int, CustomTemplateAssociation>
Return values
CustomTemplateAssociationsResponse —delete()
public
delete(array<string|int, mixed> $query) : void
Parameters
- $query : array<string|int, mixed>
Return values
void —deleteByChannelId()
public
deleteByChannelId(int $channelId) : void
Parameters
- $channelId : int
Return values
void —deleteByEntityIds()
public
deleteByEntityIds(string $type, array<string|int, mixed> $ids) : void
Parameters
- $type : string
- $ids : array<string|int, mixed>
Return values
void —deleteByIds()
public
deleteByIds(array<string|int, mixed> $ids) : void
Parameters
- $ids : array<string|int, mixed>
Return values
void —getAll()
public
getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : CustomTemplateAssociationsResponse
Parameters
- $filters : array<string|int, mixed> = []
- $page : int = 1
- $limit : int = 250
Return values
CustomTemplateAssociationsResponse —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 —multipleResourcesEndpoint()
public
multipleResourcesEndpoint() : string
Return values
string —multipleResourceUrl()
public
multipleResourceUrl() : string