TimeInTransit Service Codes, InternationalForms EEIFilingOption & AdditionalDocumentIndicator, StatusType Constants, Unit Bug Fix

CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## 0.7.9 (released 01-07-2016)
+
+- Add Shipping API Support for AdditionalDocumentIndicator in the InternationalForms node
+- Add Shipping API Support for EEIFilingOption in the InternationalForms node
+- Add TimeInTransit API Response Service Code Constants for US/EU Shipments to Entity/Service.php
+- Add Tracking API Response StatusType Constants
+
 ## 0.7.8 (released 23-06-2016)
 
 - Do not create new Guzzle object instance on each Request, but re-use it. 

src/Entity/EEIFilingOption.php

@@ -0,0 +1,203 @@
+<?php
+
+namespace Ups\Entity;
+
+use DOMDocument;
+use DOMElement;
+use Ups\NodeInterface;
+
+class EEIFilingOption implements NodeInterface
+{
+    const FO_SHIPPER = '1';  // Shipper Filed
+    const FO_UPS     = '3';  // UPS Filed
+
+    /**
+     * @var string
+     */
+    private $code;
+
+    /**
+     * @var string
+     */
+    private $emailAddress;
+
+    /**
+     * @var string
+     */
+    private $description;
+
+    /**
+     * @var UPSFiled
+     */
+    private $upsFiled;
+
+    /**
+     * @var ShipperFiled
+     */
+    private $shipperFiled;
+
+    /**
+     * @param null|object $attributes
+     */
+    public function __construct($attributes = null)
+    {
+        if (null !== $attributes) {
+            if (isset($attributes->Code)) {
+                $this->setCode($attributes->Code);
+            }
+            if (isset($attributes->EmailAddress)) {
+                $this->setEmailAddress($attributes->EmailAddress);
+            }
+            if (isset($attributes->Description)) {
+                $this->setDescription($attributes->Description);
+            }
+            if (isset($attributes->UPSFiled)) {
+                $this->setUPSFiled(new UPSFiled($attributes->UPSFiled));
+            }
+            if (isset($attributes->ShipperFiled)) {
+                $this->setShipperFiled(new ShipperFiled($attributes->ShipperFiled));
+            }
+        }
+    }
+
+    /**
+     * @param null|DOMDocument $document
+     *
+     * @return DOMElement
+     */
+    public function toNode(DOMDocument $document = null)
+    {
+        if (null === $document) {
+            $document = new DOMDocument();
+        }
+
+        $node = $document->createElement('EEIFilingOption');
+
+        $code = $this->getCode();
+        if (isset($code)) {
+            $node->appendChild($document->createElement('Code', $code));
+        }
+
+        $emailAddress = $this->getEmailAddress();
+        if (isset($emailAddress)) {
+            $node->appendChild($document->createElement('EMailAdress', $emailAddress));
+        }
+
+        $description = $this->getDescription();
+        if (isset($description)) {
+            $node->appendChild($document->createElement('Description', $description));
+        }
+
+        $upsFiled = $this->getUPSFiled();
+        if (isset($upsFiled)) {
+            $node->appendChild($upsFiled->toNode($document));
+        }
+
+        $shipperFiled = $this->getShipperFiled();
+        if (isset($shipperFiled)) {
+            $node->appendChild($shipperFiled->toNode($document));
+        }
+
+        return $node;
+    }
+
+    /**
+     * @return string
+     */
+    public function getCode()
+    {
+        return $this->code;
+    }
+
+    /**
+     * @param string $code
+     *
+     * @return $this
+     */
+    public function setCode($code)
+    {
+        $this->code = $code;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getEmailAddress()
+    {
+        return $this->emailAddress;
+    }
+
+    /**
+     * @param string $emailAddress
+     *
+     * @return $this
+     */
+    public function setEmailAddress($emailAddress)
+    {
+        $this->emailAddress = $emailAddress;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getDescription()
+    {
+        return $this->description;
+    }
+
+    /**
+     * @param string $description
+     *
+     * @return $this
+     */
+    public function setDescription($description)
+    {
+        $this->description = $description;
+
+        return $this;
+    }
+
+    /**
+     * @return UPSFiled
+     */
+    public function getUPSFiled()
+    {
+        return $this->upsFiled;
+    }
+
+    /**
+     * @param UPSFiled $upsFiled
+     *
+     * @return $this
+     */
+    public function setUPSFiled(UPSFiled $upsFiled)
+    {
+        $this->upsFiled = $upsFiled;
+
+        return $this;
+    }
+
+    /**
+     * @return ShipperFiled
+     */
+    public function getShipperFiled()
+    {
+        return $this->shipperFiled;
+    }
+
+    /**
+     * @param ShipperFiled $shipperFiled
+     *
+     * @return $this
+     */
+    public function setShipperFiled(ShipperFiled $shipperFiled)
+    {
+        $this->shipperFiled = $shipperFiled;
+
+        return $this;
+    }
+}

src/Entity/InternationalForms.php

@@ -134,6 +134,16 @@ class InternationalForms implements NodeInterface
      */
     private $freightCharges;
 
+    /**
+     * @var bool
+     */
+    private $additionalDocumentIndicator;
+
+    /**
+     * @var EEIFilingOption
+     */
+    private $eeiFilingOption;
+
     /**
      * @return array
      */
@@ -177,6 +187,9 @@ public function __construct($attributes = null)
             if (isset($attributes->CurrencyCode)) {
                 $this->setCurrencyCode($attributes->CurrencyCode);
             }
+            if (isset($attributes->EEIFilingOption)) {
+                $this->setEEIFilingOption(new EEIFilingOption($attributes->EEIFilingOption));
+            }
         }
     }
 
@@ -303,6 +316,12 @@ public function toNode(DOMDocument $document = null)
         if ($this->getFreightCharges() !== null) {
             $node->appendChild($this->getFreightCharges()->toNode($document));
         }
+        if ($this->getAdditionalDocumentIndicator() !== null) {
+            $node->appendChild($document->createElement('AdditionalDocumentIndicator'));
+        }
+        if ($this->getEEIFilingOption() !== null) {
+            $node->appendChild($this->getEEIFilingOption()->toNode($document));
+        }
         foreach ($this->products as $product) {
             $node->appendChild($product->toNode($document));
         }
@@ -457,4 +476,42 @@ public function getCurrencyCode()
     {
         return $this->currencyCode;
     }
+
+    /**
+     * @param $additionalDocumentIndicator
+     *
+     * @return $this
+     */
+    public function setAdditionalDocumentIndicator($additionalDocumentIndicator)
+    {
+        $this->additionalDocumentIndicator = $additionalDocumentIndicator;
+    }
+
+    /**
+     * @return bool
+     */
+    public function getAdditionalDocumentIndicator()
+    {
+        return $this->additionalDocumentIndicator;
+    }
+
+    /**
+     * @param EEIFilingOption $eeiFilingOption
+     *
+     * @return $this
+     */
+    public function setEEIFilingOption(EEIFilingOption $eeiFilingOption)
+    {
+        $this->eeiFilingOption = $eeiFilingOption;
+
+        return $this;
+    }
+
+    /**
+     * @return EEIFilingOption
+     */
+    public function getEEIFilingOption()
+    {
+        return $this->eeiFilingOption;
+    }
 }