BarcodeService

class Firstred\PostNL\Service\BarcodeService

Parent:: Firstred\PostNL\Service\AbstractService
Implements:: Firstred\PostNL\Service\BarcodeServiceInterface
Used traits:: Firstred\PostNL\Service\ResponseProcessor\ResponseProcessorSettersTrait

Summary

Methods

public __construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory)
public generateBarcode($generateBarcode)
public generateBarcodes($generateBarcodes)
public setApiKey($apiKey)
public setSandbox($sandbox)
public setRequestFactory($requestFactory)
public setStreamFactory($streamFactory)

Properties

protected static property Firstred\PostNL\Service\BarcodeService::$requestBuilder

protected static property Firstred\PostNL\Service\BarcodeService::$responseProcessor

Methods

public Firstred\PostNL\Service\BarcodeService::__construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory)

Parameters:

$apiKey (ParagonIE\HiddenString\HiddenString)
$sandbox (bool)
$httpClient (Firstred\PostNL\HttpClient\HttpClientInterface)
$requestFactory (Psr\Http\Message\RequestFactoryInterface)
$streamFactory (Psr\Http\Message\StreamFactoryInterface)

public Firstred\PostNL\Service\BarcodeService::generateBarcode($generateBarcode)

Generate a single 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\InvalidArgumentException
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\InvalidArgumentException
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\InvalidArgumentException
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\InvalidArgumentException
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\InvalidArgumentException
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\InvalidArgumentException
Since:: 1.0.0

public Firstred\PostNL\Service\BarcodeService::generateBarcodes($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\InvalidArgumentException

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\InvalidArgumentException

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\InvalidArgumentException

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\InvalidArgumentException

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\InvalidArgumentException

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\InvalidArgumentException

Since:

1.0.0

public Firstred\PostNL\Service\BarcodeService::setApiKey($apiKey)

Parameters:

$apiKey (ParagonIE\HiddenString\HiddenString)

Returns:

static

Since:

2.0.0

public Firstred\PostNL\Service\BarcodeService::setSandbox($sandbox)

Parameters:

$sandbox (bool)

Returns:

static

Since:

2.0.0

public Firstred\PostNL\Service\BarcodeService::setRequestFactory($requestFactory)

Parameters:

$requestFactory (Psr\Http\Message\RequestFactoryInterface)

Returns:

static

Since:

2.0.0

public Firstred\PostNL\Service\BarcodeService::setStreamFactory($streamFactory)

Parameters:

$streamFactory (Psr\Http\Message\StreamFactoryInterface)

Returns:

static

Since:

2.0.0