DynamicSearchRules
extends Endpoint
in package
FinalYes
Tags
Table of Contents
Constants
- PATH : mixed = '/dynamic-search-rules'
Properties
Methods
- __construct() : mixed
- all() : DynamicSearchRulesResults
- List dynamic search rules.
- delete() : Task
- Delete a dynamic search rule.
- deleteAll() : Task
- Delete all dynamic search rules.
- get() : DynamicSearchRule
- Get a dynamic search rule.
- update() : Task
- Create or update a dynamic search rule.
Constants
PATH
protected
mixed
PATH
= '/dynamic-search-rules'
Properties
$http
protected
Http
$http
Methods
__construct()
public
__construct(Http $http) : mixed
Parameters
- $http : Http
all()
List dynamic search rules.
public
all([DynamicSearchRulesQuery|null $options = null ]) : DynamicSearchRulesResults
This is an EXPERIMENTAL feature, which may break without a major version.
Parameters
- $options : DynamicSearchRulesQuery|null = null
Tags
Return values
DynamicSearchRulesResultsdelete()
Delete a dynamic search rule.
public
delete(non-empty-string $uid) : Task
This is an EXPERIMENTAL feature, which may break without a major version.
Parameters
- $uid : non-empty-string
-
Dynamic search rule UID
Tags
Return values
TaskdeleteAll()
Delete all dynamic search rules.
public
deleteAll() : Task
This is an EXPERIMENTAL feature, which may break without a major version.
Tags
Return values
Taskget()
Get a dynamic search rule.
public
get(non-empty-string $uid) : DynamicSearchRule
This is an EXPERIMENTAL feature, which may break without a major version.
Parameters
- $uid : non-empty-string
-
Dynamic search rule UID
Tags
Return values
DynamicSearchRuleupdate()
Create or update a dynamic search rule.
public
update(UpdateDynamicSearchRuleQuery $request) : Task
This is an EXPERIMENTAL feature, which may break without a major version.
Parameters
- $request : UpdateDynamicSearchRuleQuery
-
Partial search rule with pin and scale actions