BarcodeServiceInterface

interface Firstred\PostNL\Service\BarcodeServiceInterface

Class BarcodeService.

Parent:

Firstred\PostNL\Service\ServiceInterface

Summary

Methods

• public generateBarcodeREST($generateBarcode)

• public generateBarcodesREST($generateBarcodes)

• public generateBarcodeSOAP($generateBarcode)

• public generateBarcodesSOAP($generateBarcodes)

• public buildGenerateBarcodeRequestREST($generateBarcode)

• public processGenerateBarcodeResponseREST($response)

• public buildGenerateBarcodeRequestSOAP($generateBarcode)

• public processGenerateBarcodeResponseSOAP($response)

Methods

public Firstred\PostNL\Service\BarcodeServiceInterface::generateBarcodeREST($generateBarcode)

Generate a single barcode.

Parameters:

• $generateBarcode (Firstred\PostNL\Entity\Request\GenerateBarcode)

Returns:

string Barcode

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Since:

1.0.0

Deprecated:

1.4.0 Use `generateBarcode` instead

public Firstred\PostNL\Service\BarcodeServiceInterface::generateBarcodesREST($generateBarcodes)

Generate multiple barcodes at once.

Parameters:

• $generateBarcodes (Firstred\PostNL\Entity\Request\GenerateBarcode[])

Returns:

string[] Barcodes

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Since:

1.0.0

Deprecated:

1.4.0 Use `generateBarcodes` instead

public Firstred\PostNL\Service\BarcodeServiceInterface::generateBarcodeSOAP($generateBarcode)

Generate a single barcode.

Parameters:

• $generateBarcode (Firstred\PostNL\Entity\Request\GenerateBarcode)

Returns:

string Barcode

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Since:

1.0.0

Deprecated:

1.4.0 Use `generateBarcode` instead

public Firstred\PostNL\Service\BarcodeServiceInterface::generateBarcodesSOAP($generateBarcodes)

Generate multiple barcodes at once.

Parameters:

• $generateBarcodes (Firstred\PostNL\Entity\Request\GenerateBarcode[])

Returns:

string[] Barcodes

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Since:

1.0.0

Deprecated:

1.4.0

public Firstred\PostNL\Service\BarcodeServiceInterface::buildGenerateBarcodeRequestREST($generateBarcode)

Build the `generateBarcode` HTTP request for the REST API.

Parameters:

• $generateBarcode (Firstred\PostNL\Entity\Request\GenerateBarcode)

Returns:

\Psr\Http\Message\RequestInterface

Since:

1.0.0

Deprecated:

1.4.0

public Firstred\PostNL\Service\BarcodeServiceInterface::processGenerateBarcodeResponseREST($response)

Process GenerateBarcode REST response.

Parameters:

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

Returns:

array

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Since:

1.0.0

Deprecated:

1.4.0

public Firstred\PostNL\Service\BarcodeServiceInterface::buildGenerateBarcodeRequestSOAP($generateBarcode)

Build the `generateBarcode` HTTP request for the SOAP API.

Parameters:

• $generateBarcode (Firstred\PostNL\Entity\Request\GenerateBarcode)

Returns:

\Psr\Http\Message\RequestInterface

Since:

1.0.0

Deprecated:

1.4.0

public Firstred\PostNL\Service\BarcodeServiceInterface::processGenerateBarcodeResponseSOAP($response)

Process GenerateBarcode SOAP response.

Parameters:

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

Returns:

string

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Throws:

\Firstred\PostNL\Exception\CifDownException

Throws:

\Firstred\PostNL\Exception\CifException

Throws:

\Firstred\PostNL\Exception\HttpClientException

Throws:

\Firstred\PostNL\Exception\ResponseException

Since:

1.0.0

Deprecated:

1.4.0