WidgetTemplateApi
extends UuidCompleteResourceApi
in package
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() : void
- delete() : ResponseInterface
- get() : WidgetTemplateResponse
- getAll() : WidgetTemplatesResponse
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
- getUuid() : string
- multipleResourceUrl() : string
- setUuid() : void
- singleResourceUrl() : string
- update() : void
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(WidgetTemplate $widgetTemplate) : void
Parameters
- $widgetTemplate : WidgetTemplate
Tags
Return values
void —delete()
public
delete() : ResponseInterface
Tags
Return values
ResponseInterface —get()
public
get() : WidgetTemplateResponse
Tags
Return values
WidgetTemplateResponse —getAll()
public
getAll([array<string|int, mixed> $filters = [] ][, int $page = 0 ][, int $limit = 250 ]) : WidgetTemplatesResponse
Parameters
- $filters : array<string|int, mixed> = []
- $page : int = 0
- $limit : int = 250
Tags
Return values
WidgetTemplatesResponse —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 —getUuid()
public
getUuid() : string
Tags
Return values
string —multipleResourceUrl()
public
multipleResourceUrl() : string
Tags
Return values
string —setUuid()
public
setUuid(string $uuid) : void
Parameters
- $uuid : string
Tags
Return values
void —singleResourceUrl()
public
singleResourceUrl() : string
Tags
Return values
string —update()
public
update(WidgetTemplate $widgetTemplate) : void
Parameters
- $widgetTemplate : WidgetTemplate