ShippingStatusService
- class Firstred\PostNL\Service\ShippingStatusService
Summary
Methods
Properties
- protected static property Firstred\PostNL\Service\ShippingStatusService::$requestBuilder
- protected static property Firstred\PostNL\Service\ShippingStatusService::$responseProcessor
Methods
- public Firstred\PostNL\Service\ShippingStatusService::__construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory, $cache=null, \\DateInterval|\\DateTimeInterface|int $ttl=null)
- Parameters:
$apiKey (
ParagonIE\HiddenString\HiddenString)$sandbox (bool)
$httpClient (
Firstred\PostNL\HttpClient\HttpClientInterface)$requestFactory (
Psr\Http\Message\RequestFactoryInterface)$streamFactory (
Psr\Http\Message\StreamFactoryInterface)$cache (
Psr\Cache\CacheItemPoolInterface| null)$ttl (
DateInterval|\DateTimeInterface| int | null)
- public Firstred\PostNL\Service\ShippingStatusService::currentStatus(\\Firstred\\PostNL\\Entity\\Request\\CurrentStatusByReference|\\Firstred\\PostNL\\Entity\\Request\\CurrentStatus $currentStatus)
- Gets the current status.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:
- Returns:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Since:
1.0.0
- public Firstred\PostNL\Service\ShippingStatusService::currentStatuses($currentStatuses)
- Get current statuses.
- Parameters:
$currentStatuses (
Firstred\PostNL\Entity\Request\CurrentStatus[])
- Returns:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Since:
1.2.0
- public Firstred\PostNL\Service\ShippingStatusService::completeStatus(\\Firstred\\PostNL\\Entity\\Request\\CompleteStatusByReference|\\Firstred\\PostNL\\Entity\\Request\\CompleteStatus $completeStatus)
- Gets the complete status.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:
- Returns:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Since:
1.0.0
- public Firstred\PostNL\Service\ShippingStatusService::completeStatuses($completeStatuses)
- Get complete statuses REST.
- Parameters:
- Returns:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Since:
1.2.0
- public Firstred\PostNL\Service\ShippingStatusService::getSignature($getSignature)
- Gets the signature.
- Parameters:
$getSignature (
Firstred\PostNL\Entity\Request\GetSignature)
- Returns:
\Firstred\PostNL\Entity\Response\GetSignatureResponseSignature- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Since:
1.0.0
- public Firstred\PostNL\Service\ShippingStatusService::getSignatures($getSignatures)
- Get multiple signatures.
- Parameters:
$getSignatures (
Firstred\PostNL\Entity\Request\GetSignature[])
- Returns:
\Firstred\PostNL\Entity\Response\GetSignatureResponseSignature[]- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Since:
1.2.0
- public Firstred\PostNL\Service\ShippingStatusService::getUpdatedShipments($customer, $dateTimeFrom=null, $dateTimeTo=null)
- Get updated shipments for customer REST.
- Parameters:
$customer (
Firstred\PostNL\Entity\Customer)$dateTimeFrom (
DateTimeInterface| null)$dateTimeTo (
DateTimeInterface| null)
- Returns:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Since:
1.2.0
- public Firstred\PostNL\Service\ShippingStatusService::setApiKey($apiKey)
- Parameters:
$apiKey (
ParagonIE\HiddenString\HiddenString)
- Returns:
static
- Since:
2.0.0
- public Firstred\PostNL\Service\ShippingStatusService::setSandbox($sandbox)
- Parameters:
$sandbox (bool)
- Returns:
static
- Since:
2.0.0
- public Firstred\PostNL\Service\ShippingStatusService::setRequestFactory($requestFactory)
- Parameters:
$requestFactory (
Psr\Http\Message\RequestFactoryInterface)
- Returns:
static
- Since:
2.0.0
- public Firstred\PostNL\Service\ShippingStatusService::setStreamFactory($streamFactory)
- Parameters:
$streamFactory (
Psr\Http\Message\StreamFactoryInterface)
- Returns:
static
- Since:
2.0.0