Merge pull request #4 from pihlersimon/feature-add-support-for-pickup-points

Adds support for the pickup points deliveries

Author: markosirec

src/Adapters/ParcelAdapter.php

@@ -213,6 +213,16 @@ final class ParcelAdapter extends BaseAdapter
                 'xmlElement' => 'InfoPrivacy',
                 'maxLength' => 50
             ],
+            [
+                'getter' => 'getPickUpDelivery',
+                'xmlElement' => 'FermoDeposito',
+                'maxLength' => 1
+            ],
+            [
+                'getter' => 'getPickUpPoint',
+                'xmlElement' => 'SiglaSedeFermoDeposito',
+                'maxLength' => 4
+            ],
             [
                 'getter' => 'getShipmentType',
                 'xmlElement' => 'TipoSpedizione',

src/Models/Parcel.php

@@ -394,6 +394,40 @@ final class Parcel extends BaseModel
     private $additionalPrivacyText = 'Per info sul trattamento dati personali www.gls-italy.com/privacydest';
 
     /**
+     * Enabling pickup point delivery provided by the GLS Italy DepotPickupService.
+     * Link: https://gls-group.com/IT/it/spedire-ricevere/servizio-per-te/servizi-accessori/depotpickup.
+     *
+     * s = enable pickup point delivery.
+     * Any other value or empty = option disabled.
+     *
+     * Max length is 1.
+     *
+     * From the GLS documentation:
+     *     Se “s” allora attiva il calcolo del “Fermo Deposito” usando l’indirizzo
+     *     specificato per identificare la sigla sede di Fermo Deposito
+     *
+     * @var string
+     */
+    private $pickUpDelivery;
+
+    /**
+     * The actual pickup point where recipient will get the parcel.
+     * For this to work the $pickUp needs to be set to 's' ( enabled ).
+     *
+     * To get the identifier of the pickup point, you should use CheckAddress GLS Italy Service.
+     * https://checkaddress.gls-italy.com/wscheckaddress.asmx
+     *
+     * Max length is 4.
+     *
+     * @var string
+     *
+     *  From the GLS documentation:
+     *     I valori ammessi sono le sigle sedi GLS che fanno fermo deposito
+     *    (verificare mediante metodo CheckDepotPickUp() )
+     */
+    private $pickUpPoint;
+
+    /*
      * Shipment type (used for international shipments)
      *  P = Parcel
      *  N = National (default)
@@ -523,9 +557,9 @@ public function setPostcode(string $value): void
 
     /**
      * Postcode getter
-     * @return string
+     * @return string|null
      */
-    public function getPostcode(): string
+    public function getPostcode(): ?string
     {
         return $this->postcode;
     }
@@ -631,9 +665,9 @@ public function setWeight(string $value): void
 
     /**
      * Weight getter
-     * @return string
+     * @return string|null
      */
-    public function getWeight(): string
+    public function getWeight(): ?string
     {
         return $this->weight;
     }
@@ -998,6 +1032,42 @@ public function getAdditionalPrivacyText(): ?string
         return $this->additionalPrivacyText;
     }
 
+    /**
+     * PickUpDelivery setter
+     * @param string $value
+     */
+    public function setPickUpDelivery(string $value): void
+    {
+        $this->pickUpDelivery = $value;
+    }
+
+    /**
+     * PickUpDelivery getter.
+     * @return string|null
+     */
+    public function getPickUpDelivery(): ?string
+    {
+        return $this->pickUpDelivery;
+    }
+
+    /**
+     * PickUpPoint setter
+     * @param string $value
+     */
+    public function setPickUpPoint(string $value): void
+    {
+        $this->pickUpPoint = $value;
+    }
+
+    /**
+     * PickUpPoint setter
+     * @param string $value
+     */
+    public function getPickUpPoint(): ?string
+    {
+        return $this->pickUpPoint;
+    }
+
     /**
      * Reference persona name needed for international shipments
      *

src/Responses/AddParcelResponse.php

@@ -21,7 +21,7 @@ final class AddParcelResponse extends BaseResponse
     private $parcelId, $pdfLabel, $zplLabel, $senderName, $volumeWeight, $shippingDate, $glsDestination, $csm, $areaCode;
     private $infoPrivacy, $receiverName, $address, $city, $province, $description1, $description2, $shippingWeight;
     private $shippingNotes, $transportType, $senderInitials, $progressiveParcel, $parcelType, $glsDestinationAbbr;
-    private $printer, $totalPackages, $error;
+    private $printer, $totalPackages, $pickUpDelivery, $pickUpPoint, $error;
 
     /**
      * Parcel id setter
@@ -473,6 +473,42 @@ public function getTotalPackages(): string
         return $this->totalPackages;
     }
 
+        /**
+     * pickUpDelivery setter.
+     * @param string $pickUpDelivery
+     */
+    public function setPickUpDelivery(string $pickUpDelivery): void
+    {
+        $this->pickUpDelivery = $pickUpDelivery;
+    }
+
+    /**
+     * pickUpDelivery getter.
+     * @return string
+     */
+    public function getPickUpDelivery(): string
+    {
+        return $this->pickUpDelivery;
+    }
+
+    /**
+     * pickUpPoint setter.
+     * @param string $pickUpPoint
+     */
+    public function setPickUpPoint(string $pickUpPoint): void
+    {
+        $this->pickUpPoint = $pickUpPoint;
+    }
+
+    /**
+     * pickUpPoint getter.
+     * @return string
+     */
+    public function getPickUpPoint(): string
+    {
+        return $this->pickUpPoint;
+    }
+
     /**
      * Errors setter
      * @param string $error