ThemesApi
extends UuidResourceApi
in package
Uses
GetResource, GetAllResources, 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
- __construct() : mixed
- actions() : ThemeActionsApi
- delete() : ResponseInterface
- get() : ThemeResponse
- getAll() : ThemesResponse
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
- getUuid() : string
- job() : ThemeJobsApi
- multipleResourceUrl() : string
- setUuid() : void
- singleResourceUrl() : string
- upload() : JobIdentifierResponse
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 —actions()
public
actions() : ThemeActionsApi
Tags
Return values
ThemeActionsApi —delete()
public
delete() : ResponseInterface
Tags
Return values
ResponseInterface —get()
public
get() : ThemeResponse
Tags
Return values
ThemeResponse —getAll()
public
getAll() : ThemesResponse
Tags
Return values
ThemesResponse —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 —job()
public
job(string $jobId) : ThemeJobsApi
Parameters
- $jobId : string
Tags
Return values
ThemeJobsApi —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 —upload()
public
upload(string $filename) : JobIdentifierResponse
Parameters
- $filename : string