.. rst-class:: phpdoctorst .. role:: php(code) :language: php DeliveryDateService =================== .. php:namespace:: Firstred\PostNL\Service .. php:class:: DeliveryDateService .. rst-class:: phpdoc-description | Class DeliveryDateService\. :Parent: :php:class:`Firstred\\PostNL\\Service\\AbstractService` :Implements: :php:interface:`Firstred\\PostNL\\Service\\DeliveryDateServiceInterface` Summary ------- Methods ~~~~~~~ * :php:meth:`public getDeliveryDateREST\($getDeliveryDate\)` * :php:meth:`public getDeliveryDateSOAP\($getDeliveryDate\)` * :php:meth:`public getSentDateREST\($getSentDate\)` * :php:meth:`public getSentDateSOAP\($getSentDate\)` * :php:meth:`public buildGetDeliveryDateRequestREST\($getDeliveryDate\)` * :php:meth:`public processGetDeliveryDateResponseREST\($response\)` * :php:meth:`public buildGetDeliveryDateRequestSOAP\($getDeliveryDate\)` * :php:meth:`public processGetDeliveryDateResponseSOAP\($response\)` * :php:meth:`public buildGetSentDateRequestREST\($getSentDate\)` * :php:meth:`public processGetSentDateResponseREST\($response\)` * :php:meth:`public buildGetSentDateRequestSOAP\($getSentDate\)` * :php:meth:`public processGetSentDateResponseSOAP\($response\)` Constants --------- .. php:const:: VERSION = \'2\.2\' .. php:const:: LIVE_ENDPOINT = \'https://api\.postnl\.nl/shipment/v2\_2/calculate/date\' .. php:const:: SANDBOX_ENDPOINT = \'https://api\-sandbox\.postnl\.nl/shipment/v2\_2/calculate/date\' .. php:const:: SOAP_ACTION = \'http://postnl\.nl/cif/services/DeliveryDateWebService/IDeliveryDateWebService/GetDeliveryDate\' .. php:const:: SERVICES_NAMESPACE = \'http://postnl\.nl/cif/services/DeliveryDateWebService/\' .. php:const:: DOMAIN_NAMESPACE = \'http://postnl\.nl/cif/domain/DeliveryDateWebService/\' Properties ---------- .. php:attr:: public namespaces .. rst-class:: phpdoc-description | Namespaces uses for the SOAP version of this service\. :Type: array Methods ------- .. rst-class:: public deprecated .. php:method:: public getDeliveryDateREST( $getDeliveryDate) .. rst-class:: phpdoc-description | Get a delivery date via REST\. :Parameters: * **$getDeliveryDate** (:any:`Firstred\\PostNL\\Entity\\Request\\GetDeliveryDate `) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GetDeliveryDateResponse ` :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\\InvalidArgumentException ` :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\\InvalidArgumentException ` :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\\InvalidArgumentException ` :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\\InvalidArgumentException ` :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\\InvalidArgumentException ` :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\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Since: 1.0.0 :Deprecated: 1.4.0 Use \`getDeliveryDate\` instead .. rst-class:: public deprecated .. php:method:: public getDeliveryDateSOAP( $getDeliveryDate) .. rst-class:: phpdoc-description | Get a delivery date via SOAP\. :Parameters: * **$getDeliveryDate** (:any:`Firstred\\PostNL\\Entity\\Request\\GetDeliveryDate `) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GetDeliveryDateResponse ` :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\\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\\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\\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\\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\\NotFoundException ` :Since: 1.0.0 :Deprecated: 1.4.0 Use \`getDeliveryDate\` instead .. rst-class:: public deprecated .. php:method:: public getSentDateREST( $getSentDate) .. rst-class:: phpdoc-description | Get the sent date via REST\. :Parameters: * **$getSentDate** (:any:`Firstred\\PostNL\\Entity\\Request\\GetSentDateRequest `) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GetSentDateResponse ` :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\\InvalidArgumentException ` :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\\InvalidArgumentException ` :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\\InvalidArgumentException ` :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\\InvalidArgumentException ` :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\\InvalidArgumentException ` :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\\InvalidArgumentException ` :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\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotFoundException ` :Since: 1.0.0 :Deprecated: 1.4.0 Use \`getSentDate\` instead .. rst-class:: public deprecated .. php:method:: public getSentDateSOAP( $getSentDate) .. rst-class:: phpdoc-description | Generate a single label via SOAP\. :Parameters: * **$getSentDate** (:any:`Firstred\\PostNL\\Entity\\Request\\GetSentDateRequest `) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GetSentDateResponse ` :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\\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\\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\\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\\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\\NotFoundException ` :Since: 1.0.0 :Deprecated: 1.4.0 Use \`getSentDate\` instead .. rst-class:: public deprecated .. php:method:: public buildGetDeliveryDateRequestREST( $getDeliveryDate) .. rst-class:: phpdoc-description | Build the GetDeliveryDate request for the REST API\. :Parameters: * **$getDeliveryDate** (:any:`Firstred\\PostNL\\Entity\\Request\\GetDeliveryDate `) :Returns: :any:`\\Psr\\Http\\Message\\RequestInterface ` :Since: 1.0.0 :Deprecated: 1.4.0 .. rst-class:: public deprecated .. php:method:: public processGetDeliveryDateResponseREST( $response) .. rst-class:: phpdoc-description | Process GetDeliveryDate REST Response\. :Parameters: * **$response** (mixed) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GetDeliveryDateResponse ` | null :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Since: 1.0.0 :Deprecated: 1.4.0 .. rst-class:: public deprecated .. php:method:: public buildGetDeliveryDateRequestSOAP( $getDeliveryDate) .. rst-class:: phpdoc-description | Build the GetDeliveryDate request for the SOAP API\. :Parameters: * **$getDeliveryDate** (:any:`Firstred\\PostNL\\Entity\\Request\\GetDeliveryDate `) :Returns: :any:`\\Psr\\Http\\Message\\RequestInterface ` :Since: 1.0.0 :Deprecated: 1.4.0 .. rst-class:: public deprecated .. php:method:: public processGetDeliveryDateResponseSOAP( $response) :Parameters: * **$response** (:any:`Psr\\Http\\Message\\ResponseInterface `) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GetDeliveryDateResponse ` :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\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :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\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Since: 1.0.0 :Deprecated: 1.4.0 .. rst-class:: public deprecated .. php:method:: public buildGetSentDateRequestREST( $getSentDate) .. rst-class:: phpdoc-description | Build the GetSentDate request for the REST API\. :Parameters: * **$getSentDate** (:any:`Firstred\\PostNL\\Entity\\Request\\GetSentDateRequest `) :Returns: :any:`\\Psr\\Http\\Message\\RequestInterface ` :Since: 1.0.0 :Deprecated: 1.4.0 .. rst-class:: public deprecated .. php:method:: public processGetSentDateResponseREST( $response) .. rst-class:: phpdoc-description | Process GetSentDate REST Response\. :Parameters: * **$response** (mixed) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GetSentDateResponse ` | null :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Since: 1.0.0 :Deprecated: 1.4.0 .. rst-class:: public deprecated .. php:method:: public buildGetSentDateRequestSOAP( $getSentDate) .. rst-class:: phpdoc-description | Build the GetSentDate request for the SOAP API\. :Parameters: * **$getSentDate** (:any:`Firstred\\PostNL\\Entity\\Request\\GetSentDateRequest `) :Returns: :any:`\\Psr\\Http\\Message\\RequestInterface ` :Since: 1.0.0 :Deprecated: 1.4.0 .. rst-class:: public deprecated .. php:method:: public processGetSentDateResponseSOAP( $response) .. rst-class:: phpdoc-description | Process GetSentDate SOAP Response\. :Parameters: * **$response** (:any:`Psr\\Http\\Message\\ResponseInterface `) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GetSentDateResponse ` :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\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :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\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Since: 1.0.0 :Deprecated: 1.4.0