LabellingServiceInterface

interface Firstred\PostNL\Service\LabellingServiceInterface

Class LabellingService.

Parent

Firstred\PostNL\Service\ServiceInterface

Summary

Methods

• public generateLabelREST($generateLabel, $confirm)

• public generateLabelsREST($generateLabels)

• public generateLabelSOAP($generateLabel, $confirm)

• public generateLabelsSOAP($generateLabels)

• public buildGenerateLabelRequestREST($generateLabel, $confirm)

• public processGenerateLabelResponseREST($response)

• public buildGenerateLabelRequestSOAP($generateLabel, $confirm)

• public processGenerateLabelResponseSOAP($response)

Methods

public Firstred\PostNL\Service\LabellingServiceInterface::generateLabelREST($generateLabel, $confirm=true)

Generate a single barcode via REST.

Parameters

• $generateLabel (Firstred\PostNL\Entity\Request\GenerateLabel)

• $confirm (bool)

Returns

\Firstred\PostNL\Entity\Response\GenerateLabelResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Since

1.0.0

public Firstred\PostNL\Service\LabellingServiceInterface::generateLabelsREST($generateLabels)

Generate multiple labels at once.

Parameters

• $generateLabels (array) [‘uuid’ => [GenerateBarcode, confirm], …]

Returns

array

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

1.0.0

public Firstred\PostNL\Service\LabellingServiceInterface::generateLabelSOAP($generateLabel, $confirm=true)

Generate a single label via SOAP.

Parameters

• $generateLabel (Firstred\PostNL\Entity\Request\GenerateLabel)

• $confirm (bool)

Returns

\Firstred\PostNL\Entity\Response\GenerateLabelResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Since

1.0.0

public Firstred\PostNL\Service\LabellingServiceInterface::generateLabelsSOAP($generateLabels)

Generate multiple labels at once via SOAP.

Parameters

• $generateLabels (array) [‘uuid’ => [GenerateBarcode, confirm], …]

Returns

array

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

1.0.0

public Firstred\PostNL\Service\LabellingServiceInterface::buildGenerateLabelRequestREST($generateLabel, $confirm=true)

Build the GenerateLabel request for the REST API.

Parameters

• $generateLabel (Firstred\PostNL\Entity\Request\GenerateLabel)

• $confirm (bool)

Returns

\Psr\Http\Message\RequestInterface

Since

1.0.0

public Firstred\PostNL\Service\LabellingServiceInterface::processGenerateLabelResponseREST($response)

Process the GenerateLabel REST Response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\GenerateLabelResponse | null

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.0.0

public Firstred\PostNL\Service\LabellingServiceInterface::buildGenerateLabelRequestSOAP($generateLabel, $confirm=true)

Build the GenerateLabel request for the SOAP API.

Parameters

• $generateLabel (Firstred\PostNL\Entity\Request\GenerateLabel)

• $confirm (bool)

Returns

\Psr\Http\Message\RequestInterface

Since

1.0.0

public Firstred\PostNL\Service\LabellingServiceInterface::processGenerateLabelResponseSOAP($response)

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\GenerateLabelResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Since

1.0.0