Add label options to shipment request

src/Api/Data/Request/Shipment/LabelOptionsInterface.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * See LICENSE.md for license details.
+ */
+
+namespace Dhl\Express\Api\Data\Request\Shipment;
+
+/**
+ * LabelOptions Interface.
+ *
+ * @api
+ * @author   Daniel Fairbrother <dfairbrother@datto.com>
+ * @link     https://www.datto.com
+ */
+interface LabelOptionsInterface
+{
+    /**
+     * Returns the request waybill document option.
+     *
+     * @return string
+     */
+    public function getRequestWaybillDocument();
+}

src/Model/Request/Shipment/LabelOptions.php

@@ -0,0 +1,41 @@
+<?php
+/**
+ * See LICENSE.md for license details.
+ */
+
+namespace Dhl\Express\Model\Request\Shipment;
+
+use Dhl\Express\Api\Data\Request\Shipment\LabelOptionsInterface;
+
+
+/**
+ * LabelOptions Details.
+ *
+ * @author   Daniel Fairbrother <dfairbrother@datto.com>
+ * @link     https://www.datto.com
+ */
+class LabelOptions implements LabelOptionsInterface
+{
+    /**
+     * The service type.
+     *
+     * @var string
+     */
+    private $requestWaybillDocument;
+
+    /**
+     * LabelOptions constructor.
+     *
+     * @param LabelOptions $requestWaybillDocument
+     */
+    public function __construct(
+        $requestWaybillDocument
+    ) {
+        $this->requestWaybillDocument = $requestWaybillDocument;
+    }
+
+    public function getRequestWaybillDocument()
+    {
+        return (string) $this->requestWaybillDocument;
+    }
+}

src/Model/ShipmentRequest.php

@@ -8,6 +8,7 @@
 use Dhl\Express\Api\Data\Request\InsuranceInterface;
 use Dhl\Express\Api\Data\Request\PackageInterface;
 use Dhl\Express\Api\Data\Request\Shipment\DangerousGoods\DryIceInterface;
+use Dhl\Express\Api\Data\Request\Shipment\LabelOptionsInterface;
 use Dhl\Express\Api\Data\Request\Shipment\ShipmentDetailsInterface;
 use Dhl\Express\Api\Data\ShipmentRequestInterface;
 use Dhl\Express\Model\Request\Recipient;
@@ -61,6 +62,11 @@ class ShipmentRequest implements ShipmentRequestInterface
      */
     private $dryIce;
 
+    /**
+     * @var null|LabelOptionsInterface
+     */
+    private $labelOptions;
+
     /**
      * SoapShipmentRequest constructor.
      *
@@ -124,6 +130,11 @@ public function getDryIce()
         return $this->dryIce;
     }
 
+    public function getLabelOptions()
+    {
+        return $this->labelOptions;
+    }
+
     /**
      * Sets the billing account number.
      *
@@ -165,4 +176,18 @@ public function setDryIce(DryIceInterface $dryIce)
 
         return $this;
     }
+
+    /**
+     * Sets the label options instance.
+     *
+     * @param LabelOptionsInterface $labelOptions The label options instance
+     *
+     * @return ShipmentRequest
+     */
+    public function setLabelOptions(LabelOptionsInterface $labelOptions)
+    {
+        $this->labelOptions = $labelOptions;
+
+        return $this;
+    }
 }

src/RequestBuilder/ShipmentRequestBuilder.php

@@ -232,6 +232,15 @@ public function setInsurance($insuranceValue, $insuranceCurrency)
         return $this;
     }
 
+    public function setLabelOptions($requestWaybillDocument)
+    {
+        $this->data['labelOptions'] = [
+            'requestWaybillDocument' => $requestWaybillDocument
+        ];
+
+        return $this;
+    }
+
     public function setShipper(
         $countryCode,
         $postalCode,
@@ -404,6 +413,15 @@ public function build()
             $request->setDryIce($dryIce);
         }
 
+        // build label options
+        if (!empty($this->data['labelOptions'])) {
+            $labelOptions = new LabelOptions(
+                $this->data['labelOptions']['requestWaybillDocument']
+            );
+
+            $request->setLabelOptions($labelOptions);
+        }
+
         $this->data = [];
 
         return $request;

src/Webservice/Soap/Type/ShipmentRequest/LabelOptions.php

@@ -0,0 +1,58 @@
+<?php
+/**
+ * See LICENSE.md for license details.
+ */
+namespace Dhl\Express\Webservice\Soap\Type\ShipmentRequest;
+
+use Dhl\Express\Api\Data\Request\Shipment\LabelOptionsInterface;
+use Dhl\Express\Webservice\Soap\Type\ShipmentRequest\LabelOptions\RequestWaybillDocument;
+
+/**
+ * The LabelOptions section
+ *
+ * @api
+ * @author   Daniel Fairbrother <dfairbrother@datto.com>
+ * @link     https://www.datto.com
+ */
+class LabelOptions implements LabelOptionsInterface
+{
+    /**
+     * The request waybill document option.
+     *
+     * @var RequestWaybillDocument
+     */
+    private $RequestWaybillDocument;
+
+    /**
+     * Constructor.
+     *
+     * @param string $requestWaybillDocument The request waybill document (either Y/N or true/false)
+     */
+    public function __construct($requestWaybillDocument)
+    {
+        $this->setRequestWaybillDocument($requestWaybillDocument);
+    }
+
+    /**
+     * Returns the request waybill document option.
+     *
+     * @return RequestWaybillDocument
+     */
+    public function getRequestWaybillDocument()
+    {
+        return $this->RequestWaybillDocument;
+    }
+
+    /**
+     * Sets the delivery option.
+     *
+     * @param string $requestWaybillDocument The delivery option
+     *
+     * @return self
+     */
+    public function setRequestWaybillDocument($requestWaybillDocument)
+    {
+        $this->RequestWaybillDocument = $requestWaybillDocument;
+        return $this;
+    }
+}

src/Webservice/Soap/Type/ShipmentRequest/LabelOptions/RequestWaybillDocument.php

@@ -0,0 +1,19 @@
+<?php
+/**
+ * See LICENSE.md for license details.
+ */
+namespace Dhl\Express\Webservice\Soap\Type\ShipmentRequest\LabelOptions;
+
+use Dhl\Express\Webservice\Soap\Type\Common\YesNo;
+
+/**
+ * The RequestWaybillDocument field is used to indicate that you would like a copy of the waybill document
+ * the default in a ShipmentRequest in N
+ *
+ * @api
+ * @author   Daniel Fairbrother <dfairbrother@datto.com>
+ * @link     https://www.datto.com
+ */
+class RequestWaybillDocument extends YesNo
+{
+}

src/Webservice/Soap/Type/ShipmentRequest/RequestedShipment.php

@@ -69,6 +69,11 @@ class RequestedShipment
      */
     private $OnDemandDeliveryOptions;
 
+    /**
+     * @var null|LabelOptions
+     */
+    private $LabelOptions;
+
     /**
      * @var Ship
      */
@@ -296,6 +301,29 @@ public function setOnDemandDeliveryOptions(OnDemandDeliveryOptions $onDemandDeli
         return $this;
     }
 
+    /**
+     * Returns the on demand delivery options.
+     *
+     * @return null|LabelOptions
+     */
+    public function getLabelOptions()
+    {
+        return $this->LabelOptions;
+    }
+
+    /**
+     * Sets the on demand delivery options.
+     *
+     * @param LabelOptions $LabelOptions The on demand delivery options
+     *
+     * @return self
+     */
+    public function setLabelOptions(LabelOptions $labelOptions)
+    {
+        $this->LabelOptions = $labelOptions;
+        return $this;
+    }
+
     /**
      * Returns the shipper/recipients and optional pickup addresses.
      *

src/Webservice/Soap/Type/ShipmentRequest/ShipmentInfo.php

@@ -133,6 +133,14 @@ class ShipmentInfo
      */
     private $LabelTemplate;
 
+    /**
+     * The LabelOptions node conveys additional label options. It is an optional field. Currently only
+     * RequestWaybillDocument is supported and it takes a value of Y/N
+     *
+     * @var null|LabelOptions
+     */
+    private $LabelOptions;
+
     /**
      * The ArchiveLabelTemplate node conveys the label template used in the operation. It is an optional field.
      * This single value corresponds to the label template used to generate the Archive labels. Please check with
@@ -547,4 +555,28 @@ public function setPaperlessTradeImage($paperlessTradeImage)
         $this->PaperlessTradeImage = $paperlessTradeImage;
         return $this;
     }
+
+    /**
+     * Returns the label options.
+     *
+     * @return null|LabelOptions
+     */
+    public function getLabelOptions()
+    {
+        return $this->LabelOptions;
+    }
+
+    /**
+     * Sets the label options.
+     *
+     * @param LabelOptions $LabelOptions The label options
+     *
+     * @return self
+     */
+    public function setLabelOptions(LabelOptions $labelOptions)
+    {
+        $this->LabelOptions = $labelOptions;
+        return $this;
+    }
+
 }

src/Webservice/Soap/TypeMapper/ShipmentRequestMapper.php

@@ -17,6 +17,7 @@
 use Dhl\Express\Webservice\Soap\Type\ShipmentRequest\DangerousGoods;
 use Dhl\Express\Webservice\Soap\Type\ShipmentRequest\DangerousGoods\Content;
 use Dhl\Express\Webservice\Soap\Type\ShipmentRequest\InternationalDetail;
+use Dhl\Express\Webservice\Soap\Type\ShipmentRequest\LabelOptions;
 use Dhl\Express\Webservice\Soap\Type\ShipmentRequest\Packages;
 use Dhl\Express\Webservice\Soap\Type\ShipmentRequest\Packages\RequestedPackages;
 use Dhl\Express\Webservice\Soap\Type\ShipmentRequest\RequestedShipment;
@@ -180,6 +181,15 @@ public function map(ShipmentRequestInterface $request)
             );
         }
 
+        // Label options
+        if ($labelOptions = $request->getLabelOptions()) {
+            $requestedShipment->getShipmentInfo()->setLabelOptions(
+                new LabelOptions(
+                    $labelOptions->getRequestWaybillDocument()
+                )
+            );
+        }
+
         return new SoapShipmentRequest($requestedShipment);
     }