LocationServiceRequestBuilderInterface

interface Firstred\PostNL\Service\RequestBuilder\LocationServiceRequestBuilderInterface

Summary

Methods

public buildGetNearestLocationsRequest($getNearestLocations)
public buildGetLocationsInAreaRequest($getLocations)
public buildGetLocationRequest($getLocation)

Methods

public Firstred\PostNL\Service\RequestBuilder\LocationServiceRequestBuilderInterface::buildGetNearestLocationsRequest($getNearestLocations)

Build the 'get nearest locations' HTTP request.

Parameters:

$getNearestLocations (Firstred\PostNL\Entity\Request\GetNearestLocations)

Returns:

\Psr\Http\Message\RequestInterface

Throws:

\Firstred\PostNL\Exception\InvalidArgumentException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws:

\Firstred\PostNL\Exception\InvalidArgumentException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Since:

2.0.0

public Firstred\PostNL\Service\RequestBuilder\LocationServiceRequestBuilderInterface::buildGetLocationsInAreaRequest($getLocations)

Build the 'get locations in area' HTTP.

Parameters:

$getLocations (Firstred\PostNL\Entity\Request\GetLocationsInArea)

Returns:

\Psr\Http\Message\RequestInterface

Since:

2.0.0

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws:

\Firstred\PostNL\Exception\InvalidArgumentException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws:

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Service\RequestBuilder\LocationServiceRequestBuilderInterface::buildGetLocationRequest($getLocation)

Build the 'get single location' HTTP request.

Parameters:

$getLocation (Firstred\PostNL\Entity\Request\GetLocation)

Returns:

\Psr\Http\Message\RequestInterface

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws:

\Firstred\PostNL\Exception\InvalidArgumentException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws:

\Firstred\PostNL\Exception\InvalidArgumentException

Since:

2.0.0