.. rst-class:: phpdoctorst .. role:: php(code) :language: php PostNL ====== .. php:namespace:: Firstred\PostNL .. php:class:: PostNL .. rst-class:: phpdoc-description | Class PostNL\. :Implements: :php:interface:`Psr\\Log\\LoggerAwareInterface` Summary ------- Methods ~~~~~~~ * :php:meth:`public \_\_construct\($customer, $apiKey, $sandbox, $mode\)` * :php:meth:`public setToken\($apiKey\)` * :php:meth:`public getRestApiKey\(\)` * :php:meth:`public getApiKey\(\)` * :php:meth:`public getToken\(\)` * :php:meth:`public getCustomer\(\)` * :php:meth:`public setCustomer\($customer\)` * :php:meth:`public getSandbox\(\)` * :php:meth:`public setSandbox\($sandbox\)` * :php:meth:`public getMode\(\)` * :php:meth:`public setMode\($mode\)` * :php:meth:`public getHttpClient\(\)` * :php:meth:`public setHttpClient\($client\)` * :php:meth:`public getLogger\(\)` * :php:meth:`public setLogger\($logger\)` * :php:meth:`public resetLogger\(\)` * :php:meth:`public getRequestFactory\(\)` * :php:meth:`public setRequestFactory\($requestFactory\)` * :php:meth:`public getResponseFactory\(\)` * :php:meth:`public setResponseFactory\($responseFactory\)` * :php:meth:`public getStreamFactory\(\)` * :php:meth:`public setStreamFactory\($streamFactory\)` * :php:meth:`public getBarcodeService\(\)` * :php:meth:`public setBarcodeService\($service\)` * :php:meth:`public getLabellingService\(\)` * :php:meth:`public setLabellingService\($service\)` * :php:meth:`public getConfirmingService\(\)` * :php:meth:`public setConfirmingService\($service\)` * :php:meth:`public getShippingStatusService\(\)` * :php:meth:`public setShippingStatusService\($service\)` * :php:meth:`public getDeliveryDateService\(\)` * :php:meth:`public setDeliveryDateService\($service\)` * :php:meth:`public getTimeframeService\(\)` * :php:meth:`public setTimeframeService\($service\)` * :php:meth:`public getLocationService\(\)` * :php:meth:`public setLocationService\($service\)` * :php:meth:`public getShippingService\(\)` * :php:meth:`public setShippingService\($service\)` * :php:meth:`public generateBarcode\($type, $range, $serie, $eps\)` * :php:meth:`public generateBarcodeByCountryCode\($iso\)` * :php:meth:`public generateBarcodesByCountryCodes\($isos\)` * :php:meth:`public sendShipment\($shipment, $printertype, $confirm\)` * :php:meth:`public sendShipments\($shipments, $printertype, $confirm, $merge, $format, $positions, $a6Orientation\)` * :php:meth:`public generateLabel\($shipment, $printertype, $confirm\)` * :php:meth:`public generateLabels\($shipments, $printertype, $confirm, $merge, $format, $positions, $a6Orientation\)` * :php:meth:`public confirmShipment\($shipment\)` * :php:meth:`public confirmShipments\($shipments\)` * :php:meth:`public getCurrentStatus\($currentStatus\)` * :php:meth:`public getShippingStatusByBarcode\($barcode, $complete\)` * :php:meth:`public getShippingStatusesByBarcodes\($barcodes, $complete\)` * :php:meth:`public getShippingStatusByReference\($reference, $complete\)` * :php:meth:`public getShippingStatusesByReferences\($references, $complete\)` * :php:meth:`public getCompleteStatus\($completeStatus\)` * :php:meth:`public getUpdatedShipments\($dateTimeFrom, $dateTimeTo\)` * :php:meth:`public getSignature\($signature\)` * :php:meth:`public getSignatureByBarcode\($barcode\)` * :php:meth:`public getSignaturesByBarcodes\($barcodes\)` * :php:meth:`public getDeliveryDate\($getDeliveryDate\)` * :php:meth:`public getSentDate\($getSentDate\)` * :php:meth:`public getTimeframes\($getTimeframes\)` * :php:meth:`public getNearestLocations\($getNearestLocations\)` * :php:meth:`public getTimeframesAndNearestLocations\($getTimeframes, $getNearestLocations, $getDeliveryDate\)` * :php:meth:`public getLocationsInArea\($getLocationsInArea\)` * :php:meth:`public getLocation\($getLocation\)` * :php:meth:`public findBarcodeSerie\($type, $range, $eps\)` * :php:meth:`private checkEnvironment\(\)` * :php:meth:`public static triggerDeprecation\($package, $version, $message, $args\)` Constants --------- .. php:const:: MODE_REST = 1 :Deprecated: 1.4.0 .. php:const:: MODE_SOAP = 2 :Deprecated: 1.4.0 .. php:const:: MODE_LEGACY = 2 :Deprecated: 1.4.0 Properties ---------- .. php:attr:: public threeSCountries .. rst-class:: phpdoc-description | 3S \(or EU Pack Special\) countries\. :Type: array .. php:attr:: public a6positions .. rst-class:: phpdoc-description | A6 positions | \(index = amount of a6 left on the page\)\. :Type: array .. php:attr:: public static verifySslCerts .. rst-class:: phpdoc-description | Verify SSL certificate of the PostNL REST API\. :Type: bool :Deprecated: .. php:attr:: protected static apiKey .. rst-class:: phpdoc-description | The PostNL REST API key or SOAP username/password to be used for requests\. | In case of REST the API key is the \`Password\` property of the \`UsernameToken\` | In case of SOAP this has to be a \`UsernameToken\` object, with the following requirements: | \- Do not pass a username \(\`null\`\) | And pass the plaintext password\. :Type: string .. php:attr:: protected static customer .. rst-class:: phpdoc-description | The PostNL Customer to be used for requests\. :Type: :any:`\\Firstred\\PostNL\\Entity\\Customer ` .. php:attr:: protected static sandbox .. rst-class:: phpdoc-description | Sandbox mode\. :Type: bool .. php:attr:: protected static httpClient :Type: :any:`\\Firstred\\PostNL\\HttpClient\\ClientInterface ` .. php:attr:: protected static logger :Type: :any:`\\Psr\\Log\\LoggerInterface ` .. php:attr:: protected static requestFactory :Type: :any:`\\Psr\\Http\\Message\\RequestFactoryInterface ` | :any:`\\Firstred\\PostNL\\Factory\\RequestFactoryInterface ` .. php:attr:: protected static responseFactory :Type: :any:`\\Psr\\Http\\Message\\ResponseFactoryInterface ` | :any:`\\Firstred\\PostNL\\Factory\\ResponseFactoryInterface ` .. php:attr:: protected static streamFactory :Type: :any:`\\Psr\\Http\\Message\\StreamFactoryInterface ` | :any:`\\Firstred\\PostNL\\Factory\\StreamFactoryInterface ` .. php:attr:: protected static mode .. rst-class:: phpdoc-description | This is the current mode\. :Type: int .. php:attr:: protected static barcodeService :Type: :any:`\\Firstred\\PostNL\\Service\\BarcodeServiceInterface ` .. php:attr:: protected static labellingService :Type: :any:`\\Firstred\\PostNL\\Service\\LabellingServiceInterface ` .. php:attr:: protected static confirmingService :Type: :any:`\\Firstred\\PostNL\\Service\\ConfirmingServiceInterface ` .. php:attr:: protected static shippingStatusService :Type: :any:`\\Firstred\\PostNL\\Service\\ShippingStatusServiceInterface ` .. php:attr:: protected static deliveryDateService :Type: :any:`\\Firstred\\PostNL\\Service\\DeliveryDateServiceInterface ` .. php:attr:: protected static timeframeService :Type: :any:`\\Firstred\\PostNL\\Service\\TimeframeServiceInterface ` .. php:attr:: protected static locationService :Type: :any:`\\Firstred\\PostNL\\Service\\LocationServiceInterface ` .. php:attr:: protected static shippingService :Type: :any:`\\Firstred\\PostNL\\Service\\ShippingServiceInterface ` Methods ------- .. rst-class:: public .. php:method:: public __construct( $customer, $apiKey, $sandbox, $mode=null) .. rst-class:: phpdoc-description | PostNL constructor\. :Parameters: * **$customer** (:any:`Firstred\\PostNL\\Entity\\Customer `) Customer object. * **$apiKey** (:any:`Firstred\\PostNL\\Entity\\SOAP\\UsernameToken ` | string) API key or UsernameToken object. * **$sandbox** (bool) Whether the testing environment should be used. * **$mode** (int) Set the preferred connection strategy. Valid options are: - `MODE_REST`: New REST API - `MODE_SOAP`: New SOAP API - `MODE_LEGACY`: Not supported anymore, converts to `MODE_SOAP` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidApiModeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidApiModeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` .. rst-class:: public .. php:method:: public setToken( $apiKey) .. rst-class:: phpdoc-description | Set the token\. :Parameters: * **$apiKey** (string | :any:`\\Firstred\\PostNL\\Entity\\SOAP\\UsernameToken `) :Returns: :any:`\\Firstred\\PostNL\\PostNL ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Since: 1.0.0 .. rst-class:: public deprecated .. php:method:: public getRestApiKey() .. rst-class:: phpdoc-description | Get REST API Key\. :Returns: bool | string :Since: 1.0.0 :Deprecated: 1.4.1 Use \`getApiKey\` instead .. rst-class:: public deprecated .. php:method:: public getApiKey() .. rst-class:: phpdoc-description | Get API Key\. :Returns: null | string :Since: 1.4.1 :Deprecated: 1.4.1 Will be removed from 2\.0\.0 on, without a replacement\. .. rst-class:: public deprecated .. php:method:: public getToken() .. rst-class:: phpdoc-description | Get UsernameToken object \(for SOAP\)\. :Returns: bool | :any:`\\Firstred\\PostNL\\Entity\\SOAP\\UsernameToken ` :Since: 1.0.0 :Deprecated: 1.4.1 Use \`getApiKey\` instead .. rst-class:: public .. php:method:: public getCustomer() .. rst-class:: phpdoc-description | Get PostNL Customer\. :Returns: :any:`\\Firstred\\PostNL\\Entity\\Customer ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public setCustomer( $customer) .. rst-class:: phpdoc-description | Set PostNL Customer\. :Parameters: * **$customer** (:any:`Firstred\\PostNL\\Entity\\Customer `) :Returns: :any:`\\Firstred\\PostNL\\PostNL ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public getSandbox() .. rst-class:: phpdoc-description | Get sandbox mode\. :Returns: bool :Since: 1.0.0 .. rst-class:: public .. php:method:: public setSandbox( $sandbox) .. rst-class:: phpdoc-description | Set sandbox mode\. :Parameters: * **$sandbox** (bool) :Returns: :any:`\\Firstred\\PostNL\\PostNL ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public getMode() .. rst-class:: phpdoc-description | Get the current mode\. :Returns: int :Since: 1.0.0 .. rst-class:: public .. php:method:: public setMode( $mode) .. rst-class:: phpdoc-description | Set current mode\. :Parameters: * **$mode** (int) :Returns: :any:`\\Firstred\\PostNL\\PostNL ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidApiModeException ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public getHttpClient() .. rst-class:: phpdoc-description | HttpClient\. | Automatically load Guzzle when available :Returns: :any:`\\Firstred\\PostNL\\HttpClient\\ClientInterface ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public setHttpClient( $client) .. rst-class:: phpdoc-description | Set the HttpClient\. :Parameters: * **$client** (:any:`Firstred\\PostNL\\HttpClient\\ClientInterface `) :Since: 1.0.0 .. rst-class:: public .. php:method:: public getLogger() .. rst-class:: phpdoc-description | Get the logger\. :Returns: :any:`\\Psr\\Log\\LoggerInterface ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public setLogger( $logger) .. rst-class:: phpdoc-description | Set the logger\. :Parameters: * **$logger** (:any:`Psr\\Log\\LoggerInterface `) :Returns: :any:`\\Firstred\\PostNL\\PostNL ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public resetLogger() .. rst-class:: phpdoc-description | Set a dummy logger :Returns: static :Since: 1.2.0 .. rst-class:: public .. php:method:: public getRequestFactory() .. rst-class:: phpdoc-description | Get PSR\-7 Request factory\. :Returns: :any:`\\Psr\\Http\\Message\\RequestFactoryInterface ` | :any:`\\Firstred\\PostNL\\Factory\\RequestFactoryInterface ` :Since: 1.2.0 .. rst-class:: public .. php:method:: public setRequestFactory( $requestFactory) .. rst-class:: phpdoc-description | Set PSR\-7 Request factory\. :Parameters: * **$requestFactory** (:any:`Psr\\Http\\Message\\RequestFactoryInterface ` | :any:`\\Firstred\\PostNL\\Factory\\RequestFactoryInterface `) :Returns: static :Since: 1.2.0 :Since: 1.2.0 .. rst-class:: public .. php:method:: public getResponseFactory() .. rst-class:: phpdoc-description | Get PSR\-7 Response factory\. :Returns: :any:`\\Psr\\Http\\Message\\ResponseFactoryInterface ` | :any:`\\Firstred\\PostNL\\Factory\\ResponseFactoryInterface ` :Since: 1.2.0 .. rst-class:: public .. php:method:: public setResponseFactory( $responseFactory) .. rst-class:: phpdoc-description | Set PSR\-7 Response factory\. :Parameters: * **$responseFactory** (:any:`Psr\\Http\\Message\\ResponseFactoryInterface ` | :any:`\\Firstred\\PostNL\\Factory\\ResponseFactoryInterface `) :Returns: static :Since: 1.2.0 :Since: 1.2.0 .. rst-class:: public .. php:method:: public getStreamFactory() .. rst-class:: phpdoc-description | Set PSR\-7 Stream factory\. :Returns: :any:`\\Psr\\Http\\Message\\StreamFactoryInterface ` | :any:`\\Firstred\\PostNL\\Factory\\StreamFactoryInterface ` :Since: 1.2.0 .. rst-class:: public .. php:method:: public setStreamFactory( $streamFactory) .. rst-class:: phpdoc-description | Set PSR\-7 Stream factory\. :Parameters: * **$streamFactory** (:any:`Psr\\Http\\Message\\StreamFactoryInterface ` | :any:`\\Firstred\\PostNL\\Factory\\StreamFactoryInterface `) :Returns: static :Since: 1.2.0 :Since: 1.2.0 .. rst-class:: public .. php:method:: public getBarcodeService() .. rst-class:: phpdoc-description | Barcode service\. | Automatically load the barcode service :Returns: :any:`\\Firstred\\PostNL\\Service\\BarcodeServiceInterface ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public setBarcodeService( $service) .. rst-class:: phpdoc-description | Set the barcode service\. :Parameters: * **$service** (:any:`Firstred\\PostNL\\Service\\BarcodeServiceInterface `) :Since: 1.0.0 .. rst-class:: public .. php:method:: public getLabellingService() .. rst-class:: phpdoc-description | Labelling service\. | Automatically load the labelling service :Returns: :any:`\\Firstred\\PostNL\\Service\\LabellingServiceInterface ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public setLabellingService( $service) .. rst-class:: phpdoc-description | Set the labelling service\. :Parameters: * **$service** (:any:`Firstred\\PostNL\\Service\\LabellingServiceInterface `) :Since: 1.0.0 .. rst-class:: public .. php:method:: public getConfirmingService() .. rst-class:: phpdoc-description | Confirming service\. | Automatically load the confirming service :Returns: :any:`\\Firstred\\PostNL\\Service\\ConfirmingServiceInterface ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public setConfirmingService( $service) .. rst-class:: phpdoc-description | Set the confirming service\. :Parameters: * **$service** (:any:`Firstred\\PostNL\\Service\\ConfirmingServiceInterface `) :Since: 1.0.0 .. rst-class:: public .. php:method:: public getShippingStatusService() .. rst-class:: phpdoc-description | Shipping status service\. | Automatically load the shipping status service :Returns: :any:`\\Firstred\\PostNL\\Service\\ShippingStatusServiceInterface ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public setShippingStatusService( $service) .. rst-class:: phpdoc-description | Set the shipping status service\. :Parameters: * **$service** (:any:`Firstred\\PostNL\\Service\\ShippingStatusServiceInterface `) :Since: 1.0.0 .. rst-class:: public .. php:method:: public getDeliveryDateService() .. rst-class:: phpdoc-description | Delivery date service\. | Automatically load the delivery date service :Returns: :any:`\\Firstred\\PostNL\\Service\\DeliveryDateServiceInterface ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public setDeliveryDateService( $service) .. rst-class:: phpdoc-description | Set the delivery date service\. :Parameters: * **$service** (:any:`Firstred\\PostNL\\Service\\DeliveryDateServiceInterface `) :Since: 1.0.0 .. rst-class:: public .. php:method:: public getTimeframeService() .. rst-class:: phpdoc-description | Timeframe service\. | Automatically load the timeframe service :Returns: :any:`\\Firstred\\PostNL\\Service\\TimeframeServiceInterface ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public setTimeframeService( $service) .. rst-class:: phpdoc-description | Set the timeframe service\. :Parameters: * **$service** (:any:`Firstred\\PostNL\\Service\\TimeframeServiceInterface `) :Since: 1.0.0 .. rst-class:: public .. php:method:: public getLocationService() .. rst-class:: phpdoc-description | Location service\. | Automatically load the location service :Returns: :any:`\\Firstred\\PostNL\\Service\\LocationServiceInterface ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public setLocationService( $service) .. rst-class:: phpdoc-description | Set the location service\. :Parameters: * **$service** (:any:`Firstred\\PostNL\\Service\\LocationServiceInterface `) :Since: 1.0.0 .. rst-class:: public .. php:method:: public getShippingService() .. rst-class:: phpdoc-description | Shipping service\. | Automatically load the shipping service :Returns: mixed :Since: 1.2.0 .. rst-class:: public .. php:method:: public setShippingService( $service) .. rst-class:: phpdoc-description | Set the shipping service\. :Parameters: * **$service** (:any:`Firstred\\PostNL\\Service\\ShippingServiceInterface `) :Since: 1.2.0 .. rst-class:: public .. php:method:: public generateBarcode( $type=\'3S\', $range=null, $serie=null, $eps=false) .. rst-class:: phpdoc-description | Generate a single barcode\. :Parameters: * **$type** (string) * **$range** (string) * **$serie** (string) * **$eps** (bool) :Returns: string The barcode as a string :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidBarcodeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidBarcodeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidBarcodeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidBarcodeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidBarcodeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidBarcodeException ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public generateBarcodeByCountryCode( $iso) .. rst-class:: phpdoc-description | Generate a single barcode by country code\. :Parameters: * **$iso** (string) 2-letter Country ISO Code :Returns: string The Barcode as a string :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidBarcodeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidBarcodeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidBarcodeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidBarcodeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidBarcodeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidBarcodeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidBarcodeException ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public generateBarcodesByCountryCodes( $isos) .. rst-class:: phpdoc-description | Generate a single barcode by country code\. :Parameters: * **$isos** (array) key = iso code, value = amount of barcodes requested :Returns: array Country isos with the barcode as string :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidBarcodeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidBarcodeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidBarcodeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidBarcodeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidBarcodeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidBarcodeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidBarcodeException ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public sendShipment( $shipment, $printertype=\'GraphicFile\|PDF\', $confirm=true) .. rst-class:: phpdoc-description | Send a single shipment\. :Parameters: * **$shipment** (:any:`Firstred\\PostNL\\Entity\\Shipment `) * **$printertype** (string) * **$confirm** (bool) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\SendShipmentResponse ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Since: 1.2.0 .. rst-class:: public .. php:method:: public sendShipments( $shipments, $printertype=\'GraphicFile\|PDF\', $confirm=true, $merge=false, $format=Label::FORMAT\_A4, $positions=\[1 =\> true, 2 =\> true, 3 =\> true, 4 =\> true\], $a6Orientation=\'P\') .. rst-class:: phpdoc-description | Send multiple shipments\. :Parameters: * **$shipments** (:any:`Firstred\\PostNL\\Entity\\Shipment\[\] `) Array of shipments * **$printertype** (string) Printer type, see PostNL dev docs for available types * **$confirm** (bool) Immediately confirm the shipments * **$merge** (bool) Merge the PDFs and return them in a MyParcel way * **$format** (int) A4 or A6 * **$positions** (array) Set the positions of the A6s on the first A4 The indices should be the position number, marked with `true` or `false` These are the position numbers: ``` +-+-+ |2|4| +-+-+ |1|3| +-+-+ ``` So, for ``` +-+-+ |x|✔| +-+-+ |✔|x| +-+-+ ``` you would have to pass: ```php [ 1 => true, 2 => false, 3 => false, 4 => true, ] ``` * **$a6Orientation** (string) A6 orientation (P or L) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\SendShipmentResponse ` | string :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Since: 1.2.0 .. rst-class:: public .. php:method:: public generateLabel( $shipment, $printertype=\'GraphicFile\|PDF\', $confirm=true) .. rst-class:: phpdoc-description | Generate a single label\. :Parameters: * **$shipment** (:any:`Firstred\\PostNL\\Entity\\Shipment `) * **$printertype** (string) * **$confirm** (bool) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GenerateLabelResponse ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public generateLabels( $shipments, $printertype=\'GraphicFile\|PDF\', $confirm=true, $merge=false, $format=Label::FORMAT\_A4, $positions=\[1 =\> true, 2 =\> true, 3 =\> true, 4 =\> true\], $a6Orientation=\'P\') .. rst-class:: phpdoc-description | Generate or retrieve multiple labels\. | Note that instead of returning a GenerateLabelResponse this function can merge the labels and return a | string which contains the PDF with the merged pages as well\. :Parameters: * **$shipments** (:any:`Firstred\\PostNL\\Entity\\Shipment\[\] `) (key = ID) Shipments * **$printertype** (string) Printer type, see PostNL dev docs for available types * **$confirm** (bool) Immediately confirm the shipments * **$merge** (bool) Merge the PDFs and return them in a MyParcel way * **$format** (int) A4 or A6 * **$positions** (array) Set the positions of the A6s on the first A4 The indices should be the position number, marked with `true` or `false` These are the position numbers: ``` +-+-+ |2|4| +-+-+ |1|3| +-+-+ ``` So, for ``` +-+-+ |x|✔| +-+-+ |✔|x| +-+-+ ``` you would have to pass: ```php [ 1 => true, 2 => false, 3 => false, 4 => true, ] ``` * **$a6Orientation** (string) A6 orientation (P or L) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GenerateLabelResponse\[\] ` | string :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\PostNLException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\PostNLException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\PostNLException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\PostNLException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\PostNLException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\PostNLException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\PostNLException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\PostNLException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\PostNLException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\PostNLException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\PostNLException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\CrossReference\\CrossReferenceException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Filter\\FilterException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidMessageTimeStampException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\PdfParserException ` :Throws: :any:`\\setasign\\Fpdi\\PdfReader\\PdfReaderException ` :Throws: :any:`\\setasign\\Fpdi\\PdfParser\\Type\\PdfTypeException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\PostNLException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public confirmShipment( $shipment) .. rst-class:: phpdoc-description | Confirm a single shipment\. :Parameters: * **$shipment** (:any:`Firstred\\PostNL\\Entity\\Shipment `) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\ConfirmingResponseShipment ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public confirmShipments( $shipments) .. rst-class:: phpdoc-description | Confirm multiple shipments\. :Parameters: * **$shipments** (array) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\ConfirmingResponseShipment\[\] ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Since: 1.0.0 .. rst-class:: public deprecated .. php:method:: public getCurrentStatus( $currentStatus) .. rst-class:: phpdoc-description | Get the current status of a shipment\. | This is a combi\-function, supporting the following: | \- CurrentStatus \(by barcode\): | \- Fill the Shipment\-\>Barcode property\. Leave the rest empty\. | \- CurrentStatusByReference: | \- Fill the Shipment\-\>Reference property\. Leave the rest empty\. :Parameters: * **$currentStatus** (:any:`Firstred\\PostNL\\Entity\\Request\\CurrentStatus ` | :any:`\\Firstred\\PostNL\\Entity\\Request\\CurrentStatusByReference `) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\CurrentStatusResponse ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Since: 1.0.0 :Deprecated: 1.2.0 Use the dedicated methods \(get by phase and status are no longer working\) .. rst-class:: public .. php:method:: public getShippingStatusByBarcode( $barcode, $complete=false) .. rst-class:: phpdoc-description | Get the current status of the given shipment by barcode\. :Parameters: * **$barcode** (string) Pass a single barcode * **$complete** (bool) Return the complete status (incl. shipment history) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\CurrentStatusResponseShipment ` | :any:`\\Firstred\\PostNL\\Entity\\Response\\CompleteStatusResponseShipment ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ShipmentNotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ShipmentNotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ShipmentNotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ShipmentNotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ShipmentNotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ShipmentNotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ShipmentNotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Since: 1.2.0 .. rst-class:: public .. php:method:: public getShippingStatusesByBarcodes( $barcodes, $complete=false) .. rst-class:: phpdoc-description | Get the current statuses of the given shipments by barcodes\. :Parameters: * **$barcodes** (string[]) Pass multiple barcodes * **$complete** (bool) Return the complete status (incl. shipment history) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\CurrentStatusResponseShipment\[\] ` | :any:`\\Firstred\\PostNL\\Entity\\Response\\CompleteStatusResponseShipment\[\] ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Since: 1.2.0 .. rst-class:: public .. php:method:: public getShippingStatusByReference( $reference, $complete=false) .. rst-class:: phpdoc-description | Get the current status of the given shipment by reference\. :Parameters: * **$reference** (string) Pass a single reference * **$complete** (bool) Return the complete status (incl. shipment history) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\CurrentStatusResponseShipment ` | :any:`\\Firstred\\PostNL\\Entity\\Response\\CompleteStatusResponseShipment ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ShipmentNotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ShipmentNotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ShipmentNotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ShipmentNotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ShipmentNotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ShipmentNotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ShipmentNotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ShipmentNotFoundException ` :Since: 1.2.0 .. rst-class:: public .. php:method:: public getShippingStatusesByReferences( $references, $complete=false) .. rst-class:: phpdoc-description | Get the current statuses of the given shipments by references\. :Parameters: * **$references** (string[]) Pass multiple references * **$complete** (bool) Return the complete status (incl. shipment history) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\CurrentStatusResponseShipment\[\] ` | :any:`\\Firstred\\PostNL\\Entity\\Response\\CompleteStatusResponseShipment\[\] ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Since: 1.2.0 .. rst-class:: public deprecated .. php:method:: public getCompleteStatus( $completeStatus) .. rst-class:: phpdoc-description | Get the complete status of a shipment\. | This is a combi\-function, supporting the following: | \- CurrentStatus \(by barcode\): | \- Fill the Shipment\-\>Barcode property\. Leave the rest empty\. | \- CurrentStatusByReference: | \- Fill the Shipment\-\>Reference property\. Leave the rest empty\. | \- CurrentStatusByPhase: | \- Fill the Shipment\-\>PhaseCode property, do not pass Barcode or Reference\. | Optionally add DateFrom and/or DateTo\. | \- CurrentStatusByStatus: | \- Fill the Shipment\-\>StatusCode property\. Leave the rest empty\. :Parameters: * **$completeStatus** (:any:`Firstred\\PostNL\\Entity\\Request\\CompleteStatus `) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\CompleteStatusResponse ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Since: 1.0.0 :Deprecated: 1.2.0 Use the dedicated getShippingStatus\* methods \(get by phase and status are no longer working\) .. rst-class:: public .. php:method:: public getUpdatedShipments( $dateTimeFrom=null, $dateTimeTo=null) .. rst-class:: phpdoc-description | Get updated shipments :Parameters: * **$dateTimeFrom** (:any:`DateTimeInterface ` | null) * **$dateTimeTo** (:any:`DateTimeInterface ` | null) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\UpdatedShipmentsResponse\[\] ` :Since: 1.2.0 .. rst-class:: public deprecated .. php:method:: public getSignature( $signature) .. rst-class:: phpdoc-description | Get the signature of a shipment\. :Parameters: * **$signature** (:any:`Firstred\\PostNL\\Entity\\Request\\GetSignature `) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GetSignatureResponseSignature ` :Since: 1.0.0 :Deprecated: 1.2.0 Use the getSignature\(s\)By\* alternatives .. rst-class:: public .. php:method:: public getSignatureByBarcode( $barcode) .. rst-class:: phpdoc-description | Get the signature of a shipment\. :Parameters: * **$barcode** (string) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GetSignatureResponseSignature ` :Since: 1.2.0 .. rst-class:: public .. php:method:: public getSignaturesByBarcodes( $barcodes) .. rst-class:: phpdoc-description | Get the signature of a shipment\. :Parameters: * **$barcodes** (string[]) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GetSignatureResponseSignature\[\] ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Since: 1.2.0 .. rst-class:: public .. php:method:: public getDeliveryDate( $getDeliveryDate) .. rst-class:: phpdoc-description | Get a delivery date\. :Parameters: * **$getDeliveryDate** (:any:`Firstred\\PostNL\\Entity\\Request\\GetDeliveryDate `) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GetDeliveryDateResponse ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public getSentDate( $getSentDate) .. rst-class:: phpdoc-description | Get a shipping date\. :Parameters: * **$getSentDate** (:any:`Firstred\\PostNL\\Entity\\Request\\GetSentDateRequest `) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GetSentDateResponse ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public getTimeframes( $getTimeframes) .. rst-class:: phpdoc-description | Get timeframes\. :Parameters: * **$getTimeframes** (:any:`Firstred\\PostNL\\Entity\\Request\\GetTimeframes `) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\ResponseTimeframes ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public getNearestLocations( $getNearestLocations) .. rst-class:: phpdoc-description | Get nearest locations\. :Parameters: * **$getNearestLocations** (:any:`Firstred\\PostNL\\Entity\\Request\\GetNearestLocations `) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GetNearestLocationsResponse ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public getTimeframesAndNearestLocations( $getTimeframes, $getNearestLocations, $getDeliveryDate) .. rst-class:: phpdoc-description | All\-in\-one function for checkout widgets\. It retrieves and returns the | \- timeframes | \- locations | \- delivery date\. :Parameters: * **$getTimeframes** (:any:`Firstred\\PostNL\\Entity\\Request\\GetTimeframes `) * **$getNearestLocations** (:any:`Firstred\\PostNL\\Entity\\Request\\GetNearestLocations `) * **$getDeliveryDate** (:any:`Firstred\\PostNL\\Entity\\Request\\GetDeliveryDate `) :Returns: array \[ timeframes =\> ResponseTimeframes, locations =\> GetNearestLocationsResponse, delivery\_date =\> GetDeliveryDateResponse, \] :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidConfigurationException ` :Throws: :any:`\\Psr\\Cache\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public getLocationsInArea( $getLocationsInArea) .. rst-class:: phpdoc-description | Get locations in area\. :Parameters: * **$getLocationsInArea** (:any:`Firstred\\PostNL\\Entity\\Request\\GetLocationsInArea `) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GetLocationsInAreaResponse ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public getLocation( $getLocation) .. rst-class:: phpdoc-description | Get locations in area\. :Parameters: * **$getLocation** (:any:`Firstred\\PostNL\\Entity\\Request\\GetLocation `) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GetLocationsInAreaResponse ` :Since: 1.0.0 .. rst-class:: public .. php:method:: public findBarcodeSerie( $type, $range, $eps=null) .. rst-class:: phpdoc-description | Find a suitable serie for the barcode\. :Parameters: * **$type** (string) * **$range** (string) * **$eps** (bool) Indicates whether it is an EPS Shipment :Returns: string :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidBarcodeException ` :Since: 1.0.0 .. rst-class:: private .. php:method:: private checkEnvironment() .. rst-class:: phpdoc-description | Check whether this library will work in the current environment :Since: 1.2.0 .. rst-class:: public static .. php:method:: public static triggerDeprecation( $package, $version, $message, ...$args) .. rst-class:: phpdoc-description | Triggers a silenced deprecation notice\. | Copyright \(c\) 2020\-present Fabien Potencier | | Permission is hereby granted, free of charge, to any person obtaining a copy | of this software and associated documentation files \(the "Software"\), to deal | in the Software without restriction, including without limitation the rights | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | copies of the Software, and to permit persons to whom the Software is furnished | to do so, subject to the following conditions: | | The above copyright notice and this permission notice shall be included in all | copies or substantial portions of the Software\. | | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT\. IN NO EVENT SHALL THE | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | THE SOFTWARE\. :Parameters: * **$package** (string) The name of the Composer package that is triggering the deprecation * **$version** (string) The version of the package that introduced the deprecation * **$message** (string) The message of the deprecation * **...$args** (mixed) Values to insert in the message using printf() formatting :Since: 1.4.0