Commercetools\Import\Client\Resource\ByProjectKeyImportContainersGet Class Reference

Inheritance diagram for Commercetools\Import\Client\Resource\ByProjectKeyImportContainersGet:

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)
	withLimit ($limit)
	withOffset ($offset)
	withSort ($sort)
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 ()

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 SecuredByViewImportContainers<ByProjectKeyImportContainersGet>

Definition at line 33 of file ByProjectKeyImportContainersGet.php.

Constructor & Destructor Documentation

__construct()

Commercetools\Import\Client\Resource\ByProjectKeyImportContainersGet::__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 39 of file ByProjectKeyImportContainersGet.php.

Member Function Documentation

execute()

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

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

Returns

null|T|ImportContainerPagedResponse|JsonObject

Definition at line 77 of file ByProjectKeyImportContainersGet.php.

executeAsync()

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

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

Returns

PromiseInterface

Definition at line 100 of file ByProjectKeyImportContainersGet.php.

mapFromResponse()

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

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

Returns

ImportContainerPagedResponse|JsonObject|T|null

Definition at line 50 of file ByProjectKeyImportContainersGet.php.

withLimit()

Commercetools\Import\Client\Resource\ByProjectKeyImportContainersGet::withLimit

(

$limit

)

@psalm-param scalar|scalar[] $limit

Definition at line 123 of file ByProjectKeyImportContainersGet.php.

withOffset()

Commercetools\Import\Client\Resource\ByProjectKeyImportContainersGet::withOffset

(

$offset

)

@psalm-param scalar|scalar[] $offset

Definition at line 132 of file ByProjectKeyImportContainersGet.php.

withSort()

Commercetools\Import\Client\Resource\ByProjectKeyImportContainersGet::withSort

(

$sort

)

@psalm-param scalar|scalar[] $sort

Definition at line 141 of file ByProjectKeyImportContainersGet.php.

---

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

• lib/commercetools-import/src/Client/Resource/ByProjectKeyImportContainersGet.php