ShippingStatusServiceRequestBuilderInterface

interface Firstred\PostNL\Service\RequestBuilder\ShippingStatusServiceRequestBuilderInterface

Summary

Methods

public buildCurrentStatusRequest($currentStatus)
public buildCompleteStatusRequest($completeStatus)
public buildGetSignatureRequest($getSignature)
public buildGetUpdatedShipmentsRequest($getUpdatedShipments)

Methods

public Firstred\PostNL\Service\RequestBuilder\ShippingStatusServiceRequestBuilderInterface::buildCurrentStatusRequest(\\Firstred\\PostNL\\Entity\\Request\\CurrentStatusByReference|\\Firstred\\PostNL\\Entity\\Request\\CurrentStatus $currentStatus)

Build the 'get current status' HTTP request.

This function auto-detects and adjusts the following requests:
- CurrentStatus
- CurrentStatusByReference

Throws:: \Firstred\PostNL\Exception\InvalidArgumentException
Throws:: \Firstred\PostNL\Exception\InvalidConfigurationException
Throws:: \Firstred\PostNL\Exception\InvalidArgumentException
Throws:: \Firstred\PostNL\Exception\InvalidConfigurationException
Since:: 2.0.0

public Firstred\PostNL\Service\RequestBuilder\ShippingStatusServiceRequestBuilderInterface::buildCompleteStatusRequest($completeStatus)

Build the 'get complete status' HTTP request.

This function auto-detects and adjusts the following requests:
- CompleteStatus
- CompleteStatusByReference
- CompleteStatusByPhase
- CompleteStatusByStatus

Parameters:

$completeStatus (Firstred\PostNL\Entity\Request\CompleteStatus)

Returns:

\Psr\Http\Message\RequestInterface

Throws:

\Firstred\PostNL\Exception\InvalidArgumentException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws:

\Firstred\PostNL\Exception\InvalidArgumentException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Since:

2.0.0

public Firstred\PostNL\Service\RequestBuilder\ShippingStatusServiceRequestBuilderInterface::buildGetSignatureRequest($getSignature)

Build the 'get signature' HTTP request.

Parameters:

$getSignature (Firstred\PostNL\Entity\Request\GetSignature)

Returns:

\Psr\Http\Message\RequestInterface

Throws:

\Firstred\PostNL\Exception\InvalidArgumentException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws:

\Firstred\PostNL\Exception\InvalidArgumentException

Throws:

\Firstred\PostNL\Exception\InvalidConfigurationException

Since:

2.0.0

public Firstred\PostNL\Service\RequestBuilder\ShippingStatusServiceRequestBuilderInterface::buildGetUpdatedShipmentsRequest($getUpdatedShipments)

Build the 'get updated shipments' HTTP request.

Parameters: