Add option to return negotiated rates

Author: proclame

demo/create-label.php

@@ -19,6 +19,7 @@
 use RahulGodiyal\PhpUpsApiWrapper\Entity\ShipmentRequest;
 use RahulGodiyal\PhpUpsApiWrapper\Entity\Shipper;
 use RahulGodiyal\PhpUpsApiWrapper\Entity\ShipQuery;
+use RahulGodiyal\PhpUpsApiWrapper\Entity\ShippingRatingOptions;
 use RahulGodiyal\PhpUpsApiWrapper\Entity\ShipTo;
 use RahulGodiyal\PhpUpsApiWrapper\Entity\UnitOfMeasurement;
 use RahulGodiyal\PhpUpsApiWrapper\Ship;
@@ -153,6 +154,13 @@
 $shipment->setPaymentInformation($paymentInformation);
 $shipment->setService($service);
 $shipment->setPackage($package);
+
+/************ ShippingRatingOptions **********/
+$shippingRatingOptions = new ShippingRatingOptions(); // optional
+$shippingRatingOptions->setNegotiatedRatesIndicator(true); // optional
+$shipment->setShippingRatingOptions($shippingRatingOptions); // optional
+/************ End ShippingRatingOptions **********/
+
 /************ End Shipment **********/
 
 /************ Label Specification **********/

src/Entity/Shipment.php

@@ -12,11 +12,13 @@ class Shipment
     private PaymentInformation $paymentInformation;
     private Service $service;
     private Package $package;
+    private ShippingRatingOptions $shippingRatingOptions;
 
     public function __construct()
     {
         $this->returnService = new ReturnService();
         $this->paymentInformation = new PaymentInformation();
+        $this->shippingRatingOptions = new ShippingRatingOptions();
     }
 
     public function setDescription(string $description): self
@@ -107,6 +109,17 @@ public function getPackage(): Package
         return $this->package;
     }
 
+    public function setShippingRatingOptions(ShippingRatingOptions $shippingRatingOptions): self
+    {
+        $this->shippingRatingOptions = $shippingRatingOptions;
+        return $this;
+    }
+
+    public function getShippingRatingOptions(): ShippingRatingOptions
+    {
+        return $this->shippingRatingOptions;
+    }
+
     public function toArray(): array
     {
         $shipment = [
@@ -132,6 +145,10 @@ public function toArray(): array
             $shipment["ReturnService"] = $this->returnService->toArray();
         }
 
+        if ($this->shippingRatingOptions->exists()) {
+            $shipment["ShipmentRatingOptions"] = $this->shippingRatingOptions->toArray();
+        }
+
         return $shipment;
     }
 }

src/Entity/ShippingRatingOptions.php

@@ -0,0 +1,67 @@
+<?php
+
+namespace RahulGodiyal\PhpUpsApiWrapper\Entity;
+
+class ShippingRatingOptions
+{
+    private bool $negotiatedRatesIndicator = false;
+    private bool $frsShipmentIndicator = false;
+    private bool $rateChartIndicator = false;
+
+    public function exists(): bool
+    {
+        return $this->negotiatedRatesIndicator || $this->frsShipmentIndicator || $this->rateChartIndicator;
+    }
+
+    public function setNegotiatedRatesIndicator(bool $negotiatedRatesIndicator): self
+    {
+        $this->negotiatedRatesIndicator = $negotiatedRatesIndicator;
+        return $this;
+    }
+
+    public function getNegotiatedRatesIndicator(): bool
+    {
+        return $this->negotiatedRatesIndicator;
+    }
+
+    public function setFrsShipmentIndicator(bool $frsShipmentIndicator): self
+    {
+        $this->frsShipmentIndicator = $frsShipmentIndicator;
+        return $this;
+    }
+
+    public function getFrsShipmentIndicator(): bool
+    {
+        return $this->frsShipmentIndicator;
+    }
+
+    public function setRateChartIndicator(bool $rateChartIndicator): self
+    {
+        $this->rateChartIndicator = $rateChartIndicator;
+        return $this;
+    }
+
+    public function getRateChartIndicator(): bool
+    {
+        return $this->rateChartIndicator;
+    }
+
+    public function toArray(): array
+    {
+        $options = [];
+
+        if ($this->negotiatedRatesIndicator) {
+            $options["NegotiatedRatesIndicator"] = "";
+        }
+
+        if ($this->frsShipmentIndicator) {
+            $options["FRSShipmentIndicator"] = "";
+        }
+
+        if (!empty($this->rateChartIndicator)) {
+            $options["RateChartIndicator"] = "";
+        }
+
+        return $options;
+    }
+}