ComplexRulesApi
extends ResourceApi
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
- COMPLEX_RULE_ENDPOINT = 'catalog/products/%d/complex-rules/%d'
- COMPLEX_RULES_ENDPOINT = 'catalog/products/%d/complex-rules'
- RESOURCE_NAME = 'complex-rules'
- __construct() : mixed
- create() : ComplexRuleResponse
- delete() : ResponseInterface
- get() : ComplexRuleResponse
- getAll() : ComplexRulesResponse
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
- multipleResourceUrl() : string
- singleResourceUrl() : string
- update() : ComplexRuleResponse
Constants
COMPLEX_RULE_ENDPOINT
public
mixed
COMPLEX_RULE_ENDPOINT
= 'catalog/products/%d/complex-rules/%d'
Tags
COMPLEX_RULES_ENDPOINT
public
mixed
COMPLEX_RULES_ENDPOINT
= 'catalog/products/%d/complex-rules'
Tags
RESOURCE_NAME
public
mixed
RESOURCE_NAME
= 'complex-rules'
Tags
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(ComplexRule $complexRule) : ComplexRuleResponse
Parameters
- $complexRule : ComplexRule
Tags
Return values
ComplexRuleResponse —delete()
public
delete() : ResponseInterface
Tags
Return values
ResponseInterface —get()
public
get() : ComplexRuleResponse
Tags
Return values
ComplexRuleResponse —getAll()
public
getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : ComplexRulesResponse
Parameters
- $filters : array<string|int, mixed> = []
- $page : int = 1
- $limit : int = 250
Tags
Return values
ComplexRulesResponse —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 —multipleResourceUrl()
public
abstract multipleResourceUrl() : string
Tags
Return values
string —singleResourceUrl()
public
abstract singleResourceUrl() : string
Tags
Return values
string —update()
public
update(ComplexRule $complexRule) : ComplexRuleResponse
Parameters
- $complexRule : ComplexRule