Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSuggestGet Class Reference

Inheritance diagram for Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSuggestGet:

Public Member Functions
	__construct (string $projectKey, $body=null, array $headers=[], ClientInterface $client=null)
	mapFromResponse (?ResponseInterface $response, string $resultType=null)
	execute (array $options=[], string $resultType=null)
	executeAsync (array $options=[], string $resultType=null)
	withFuzzy ($fuzzy)
	withSearchKeywords (string $locale, $searchKeywords)
	withSort ($sort)
	withLimit ($limit)
	withOffset ($offset)
	withWithTotal ($withTotal)
	withStaged ($staged)
Public Member Functions inherited from Commercetools\Client\ApiRequest
	__construct (?ClientInterface $client, string $method, string $uri, array $headers=[], $body=null, string $version='1.1')
	withQueryParam (string $parameterName, $value)
	send (array $options=[])
	sendAsync (array $options=[])
	getClient ()
Public Member Functions inherited from Commercetools\Api\Client\Resource\Sortable
	withSort (string $sort)
Public Member Functions inherited from Commercetools\Api\Client\Resource\Paging
	withLimit (int $limit)
	withOffset (int $offset)
	withWithTotal (bool $withTotal)
Public Member Functions inherited from Commercetools\Api\Client\Resource\ProjectionSelecting
	withStaged (bool $staged)

Additional Inherited Members
Protected Member Functions inherited from Commercetools\Client\ApiRequest
	ensureHeader (array $headers, string $header, $defaultValue)
	responseData (ResponseInterface $response)

Detailed Description

@psalm-suppress PropertyNotSetInConstructor @template-implements Sortable<ByProjectKeyProductProjectionsSuggestGet> @template-implements Paging<ByProjectKeyProductProjectionsSuggestGet> @template-implements ProjectionSelecting<ByProjectKeyProductProjectionsSuggestGet> @template-implements Errorable<ByProjectKeyProductProjectionsSuggestGet> @template-implements Deprecatable200<ByProjectKeyProductProjectionsSuggestGet>

Definition at line 39 of file ByProjectKeyProductProjectionsSuggestGet.php.

Constructor & Destructor Documentation

__construct()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSuggestGet::__construct	(	string	$projectKey,
			$body = null,
		array	$headers = [],
		ClientInterface	$client = null
	)

Parameters

?object|array|string

$body @psalm-param array<string, scalar|scalar[]> $headers

Definition at line 45 of file ByProjectKeyProductProjectionsSuggestGet.php.

Member Function Documentation

execute()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSuggestGet::execute	(	array	$options = [],
		string	$resultType = null
	)

@template T of JsonObject @psalm-param ?class-string<T> $resultType

Returns

null|T|ErrorResponse|JsonObject|SuggestionResult

Definition at line 107 of file ByProjectKeyProductProjectionsSuggestGet.php.

executeAsync()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSuggestGet::executeAsync	(	array	$options = [],
		string	$resultType = null
	)

@template T of JsonObject @psalm-param ?class-string<T> $resultType

Returns

PromiseInterface

Definition at line 130 of file ByProjectKeyProductProjectionsSuggestGet.php.

mapFromResponse()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSuggestGet::mapFromResponse	(	?ResponseInterface	$response,
		string	$resultType = null
	)

@template T of JsonObject @psalm-param ?class-string<T> $resultType

Returns

ErrorResponse|JsonObject|SuggestionResult|T|null

Definition at line 56 of file ByProjectKeyProductProjectionsSuggestGet.php.

withFuzzy()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSuggestGet::withFuzzy

(

$fuzzy

)

@psalm-param scalar|scalar[] $fuzzy

Definition at line 153 of file ByProjectKeyProductProjectionsSuggestGet.php.

withLimit()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSuggestGet::withLimit

(

$limit

)

@psalm-param scalar|scalar[] $limit

Definition at line 180 of file ByProjectKeyProductProjectionsSuggestGet.php.

withOffset()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSuggestGet::withOffset

(

$offset

)

@psalm-param scalar|scalar[] $offset

Definition at line 189 of file ByProjectKeyProductProjectionsSuggestGet.php.

withSearchKeywords()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSuggestGet::withSearchKeywords	(	string	$locale,
			$searchKeywords
	)

@psalm-param string $locale @psalm-param scalar|scalar[] $searchKeywords

Definition at line 162 of file ByProjectKeyProductProjectionsSuggestGet.php.

withSort()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSuggestGet::withSort

(

$sort

)

@psalm-param scalar|scalar[] $sort

Definition at line 171 of file ByProjectKeyProductProjectionsSuggestGet.php.

withStaged()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSuggestGet::withStaged

(

$staged

)

@psalm-param scalar|scalar[] $staged

Definition at line 207 of file ByProjectKeyProductProjectionsSuggestGet.php.

withWithTotal()

Commercetools\Api\Client\Resource\ByProjectKeyProductProjectionsSuggestGet::withWithTotal

(

$withTotal

)

@psalm-param scalar|scalar[] $withTotal

Definition at line 198 of file ByProjectKeyProductProjectionsSuggestGet.php.

---

The documentation for this class was generated from the following file:

• lib/commercetools-api/src/Client/Resource/ByProjectKeyProductProjectionsSuggestGet.php