Merge pull request #6 from proclame/add-reference-number

Add Package Reference to demo + Add option to add Shipment Reference

Author: rgodiyal

demo/create-label.php

@@ -11,6 +11,7 @@
 use RahulGodiyal\PhpUpsApiWrapper\Entity\Packaging;
 use RahulGodiyal\PhpUpsApiWrapper\Entity\PaymentInformation;
 use RahulGodiyal\PhpUpsApiWrapper\Entity\Phone;
+use RahulGodiyal\PhpUpsApiWrapper\Entity\ReferenceNumber;
 use RahulGodiyal\PhpUpsApiWrapper\Entity\Request;
 use RahulGodiyal\PhpUpsApiWrapper\Entity\Service;
 use RahulGodiyal\PhpUpsApiWrapper\Entity\ShipFrom;
@@ -137,14 +138,21 @@
 $packageWeight->setWeight("5");
 // End Package Weight
 
+$packageReferenceNumber = new ReferenceNumber(); // optional
+$packageReferenceNumber->setValue("XXXXXXXXX"); // optional
+
 $package = new Package();
 $package->setDescription(""); // optional
 $package->setPackaging($packaging);
 $package->setDimensions($dimensions); // optional
 $package->setPackageWeight($packageWeight); // optional
+$package->setReferenceNumber($packageReferenceNumber); //optional
 /************ End Package **********/
 
 /************ Shipment **********/
+$shipmentReferenceNumber = new ReferenceNumber(); // optional
+$shipmentReferenceNumber->setValue("XXXXXXXXX"); // optional
+
 $shipment = new Shipment();
 $shipment->setDescription("Ship WS test");
 $shipment->setShipper($shipper);
@@ -153,6 +161,7 @@
 $shipment->setPaymentInformation($paymentInformation);
 $shipment->setService($service);
 $shipment->setPackage($package);
+$shipment->setReferenceNumber($shipmentReferenceNumber); // optional
 /************ End Shipment **********/
 
 /************ Label Specification **********/

src/Entity/Shipment.php

@@ -12,11 +12,13 @@ class Shipment
     private PaymentInformation $paymentInformation;
     private Service $service;
     private Package $package;
+    private ReferenceNumber $referenceNumber;
 
     public function __construct()
     {
         $this->returnService = new ReturnService();
         $this->paymentInformation = new PaymentInformation();
+        $this->referenceNumber = new ReferenceNumber();
     }
 
     public function setDescription(string $description): self
@@ -30,6 +32,17 @@ public function getDescription(): string
         return $this->description;
     }
 
+    public function setReferenceNumber(ReferenceNumber $referenceNumber): self
+    {
+        $this->referenceNumber = $referenceNumber;
+        return $this;
+    }
+
+    public function getReferenceNumber(): ReferenceNumber
+    {
+        return $this->referenceNumber;
+    }
+
     public function setReturnService(ReturnService $returnService): self
     {
         $this->returnService = $returnService;
@@ -132,6 +145,10 @@ public function toArray(): array
             $shipment["ReturnService"] = $this->returnService->toArray();
         }
 
+        if ($this->referenceNumber->exists()) {
+            $shipment["ReferenceNumber"] = $this->referenceNumber->toArray();
+        }
+
         return $shipment;
     }
 }