DynamicSearchRules
extends Endpoint
in package
FinalYes
Tags
Table of Contents
Constants
- PATH = '/dynamic-search-rules'
Properties
Methods
- __construct() : mixed
- all() : DynamicSearchRulesResults
- delete() : array<string|int, mixed>|null
- get() : DynamicSearchRule
- show() : array<string|int, mixed>|null
- update() : DynamicSearchRule
Constants
PATH
protected
mixed
PATH
= '/dynamic-search-rules'
Properties
$apiKey
protected
string|null
$apiKey
$http
protected
Http
$http
Methods
__construct()
public
__construct(Http $http[, string|null $apiKey = null ]) : mixed
Parameters
- $http : Http
- $apiKey : string|null = null
all()
public
all([DynamicSearchRulesQuery|null $options = null ]) : DynamicSearchRulesResults
Parameters
- $options : DynamicSearchRulesQuery|null = null
Return values
DynamicSearchRulesResultsdelete()
public
delete(non-empty-string $uid) : array<string|int, mixed>|null
Parameters
- $uid : non-empty-string
Return values
array<string|int, mixed>|nullget()
public
get(non-empty-string $uid) : DynamicSearchRule
Parameters
- $uid : non-empty-string
Return values
DynamicSearchRuleshow()
public
show() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullupdate()
public
update(UpdateDynamicSearchRuleQuery $request) : DynamicSearchRule
Parameters
- $request : UpdateDynamicSearchRuleQuery