ResourceWithBatchUpdateApi
extends ResourceApi
in package
Uses
BatchUpdateResource
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
- batchUpdate() : PaginatedResponse
- delete() : ResponseInterface
- get() : SingleResourceResponse
- getAll() : PaginatedResponse
- getClient() : Client
- getMaxRetries() : int
- getParentResourceId() : int|null
- getResourceId() : int|null
- multipleResourceUrl() : string
- setMaxRetries() : void
- singleResourceUrl() : string
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 —batchUpdate()
public
abstract batchUpdate(array<string|int, mixed> $resources) : PaginatedResponse
Parameters
- $resources : array<string|int, mixed>
Tags
Return values
PaginatedResponse —delete()
public
delete() : ResponseInterface
Tags
Return values
ResponseInterface —get()
public
abstract get() : SingleResourceResponse
Tags
Return values
SingleResourceResponse —getAll()
public
abstract getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : PaginatedResponse
Parameters
- $filters : array<string|int, mixed> = []
- $page : int = 1
- $limit : int = 250
Tags
Return values
PaginatedResponse —getClient()
public
getClient() : Client
Tags
Return values
Client —getMaxRetries()
public
getMaxRetries() : int
Tags
Return values
int —getParentResourceId()
public
getParentResourceId() : int|null
Tags
Return values
int|null —getResourceId()
public
getResourceId() : int|null
Tags
Return values
int|null —multipleResourceUrl()
public
abstract multipleResourceUrl() : string
Tags
Return values
string —setMaxRetries()
public
setMaxRetries(int $maxRetries) : void
Parameters
- $maxRetries : int
Tags
Return values
void —singleResourceUrl()
public
abstract singleResourceUrl() : string