.. rst-class:: phpdoctorst .. role:: php(code) :language: php LabellingServiceInterface ========================= .. php:namespace:: Firstred\PostNL\Service .. php:interface:: LabellingServiceInterface .. rst-class:: phpdoc-description | Class LabellingService\. :Parent: :php:interface:`Firstred\\PostNL\\Service\\ServiceInterface` Summary ------- Methods ~~~~~~~ * :php:meth:`public generateLabelREST\($generateLabel, $confirm\)` * :php:meth:`public generateLabelsREST\($generateLabels\)` * :php:meth:`public generateLabelSOAP\($generateLabel, $confirm\)` * :php:meth:`public generateLabelsSOAP\($generateLabels\)` * :php:meth:`public buildGenerateLabelRequestREST\($generateLabel, $confirm\)` * :php:meth:`public processGenerateLabelResponseREST\($response\)` * :php:meth:`public buildGenerateLabelRequestSOAP\($generateLabel, $confirm\)` * :php:meth:`public processGenerateLabelResponseSOAP\($response\)` Methods ------- .. rst-class:: public deprecated .. php:method:: public generateLabelREST( $generateLabel, $confirm=true) .. rst-class:: phpdoc-description | Generate a single barcode via REST\. :Parameters: * **$generateLabel** (:any:`Firstred\\PostNL\\Entity\\Request\\GenerateLabel `) * **$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:`\\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 \`generateLabels\` instead .. rst-class:: public deprecated .. php:method:: public generateLabelsREST( $generateLabels) .. rst-class:: phpdoc-description | Generate multiple labels at once\. :Parameters: * **$generateLabels** (array) ['uuid' => [GenerateBarcode, confirm], ...] :Returns: array :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 ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Since: 1.0.0 :Deprecated: 1.4.0 Use \`generateLabels\` instead .. rst-class:: public deprecated .. php:method:: public generateLabelSOAP( $generateLabel, $confirm=true) .. rst-class:: phpdoc-description | Generate a single label via SOAP\. :Parameters: * **$generateLabel** (:any:`Firstred\\PostNL\\Entity\\Request\\GenerateLabel `) * **$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:`\\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 Use \`generateLabels\` .. rst-class:: public deprecated .. php:method:: public generateLabelsSOAP( $generateLabels) .. rst-class:: phpdoc-description | Generate multiple labels at once via SOAP\. :Parameters: * **$generateLabels** (array) ['uuid' => [GenerateBarcode, confirm], ...] :Returns: array :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\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :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\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Since: 1.0.0 :Deprecated: 1.4.0 Use \`generateLabels\` instead .. rst-class:: public .. php:method:: public buildGenerateLabelRequestREST( $generateLabel, $confirm=true) .. rst-class:: phpdoc-description | Build the GenerateLabel request for the REST API\. :Parameters: * **$generateLabel** (:any:`Firstred\\PostNL\\Entity\\Request\\GenerateLabel `) * **$confirm** (bool) :Returns: :any:`\\Psr\\Http\\Message\\RequestInterface ` :Since: 1.0.0 .. rst-class:: public deprecated .. php:method:: public processGenerateLabelResponseREST( $response) .. rst-class:: phpdoc-description | Process the GenerateLabel REST Response\. :Parameters: * **$response** (:any:`Psr\\Http\\Message\\ResponseInterface `) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GenerateLabelResponse ` | 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 buildGenerateLabelRequestSOAP( $generateLabel, $confirm=true) .. rst-class:: phpdoc-description | Build the GenerateLabel request for the SOAP API\. :Parameters: * **$generateLabel** (:any:`Firstred\\PostNL\\Entity\\Request\\GenerateLabel `) * **$confirm** (bool) :Returns: :any:`\\Psr\\Http\\Message\\RequestInterface ` :Since: 1.0.0 :Deprecated: 1.4.0 .. rst-class:: public deprecated .. php:method:: public processGenerateLabelResponseSOAP( $response) :Parameters: * **$response** (:any:`Psr\\Http\\Message\\ResponseInterface `) :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:`\\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