Merge pull request #50 from JeremyDunn/async-transaction-service

Async transaction service

Author: JeremyDunn

CHANGELOG.md

@@ -1,5 +1,25 @@
 # CHANGELOG
 
+## 2.3 (released 2017-11-02)
+- Added ASYNC Transaction Service
+
+|Service|Version|
+|---|---|
+|Address Validation|2|
+|Close|2|
+|Courier Dispatch|3|
+|Locator|2|
+|Package Movement Information|5|
+|Pickup|3|
+|Rate|10|
+|Return Tag|1|
+|Ship|12|
+|Track|5|
+|Upload Document|1|
+|Open Ship|11|
+|Validation Availability and Commitment Service|6|
+|ASYNC Transaction Service|4|
+
 ## 2.2 (released 2017-08-19)
 - Added Validation Availability and Commitment Service
 

README.md

@@ -23,6 +23,13 @@ Each web service has it's own class namespace. See the official FedEx web servic
 * [Upload Document Service](src/FedEx/UploadDocumentService)
 * [Open Ship Service](src/FedEx/OpenShipService)
 * [Validation Availability and Commitment Service](src/FedEx/ValidationAvailabilityAndCommitmentService)
+* [ASYNC Transaction Service](src/FedEx/AsyncService)
+
+## Installation
+
+```
+composer require jeremy-dunn/php-fedex-api-wrapper
+```
 
 ## Using the library
 

src/FedEx/AsyncService/ComplexType/ArtifactPart.php

@@ -0,0 +1,49 @@
+<?php
+namespace FedEx\AsyncService\ComplexType;
+
+use FedEx\AbstractComplexType;
+
+/**
+ * ArtifactPart
+ *
+ * @author      Jeremy Dunn <[email protected]>
+ * @package     PHP FedEx API wrapper
+ * @subpackage  ASync Service
+ *
+ * @property int $SequenceNumber
+ * @property string $Contents
+
+ */
+class ArtifactPart extends AbstractComplexType
+{
+    /**
+     * Name of this complex type
+     *
+     * @var string
+     */
+    protected $name = 'ArtifactPart';
+
+    /**
+     * Specifies the sequence of this part of the artifact.
+     *
+     * @param int $sequenceNumber
+     * @return $this
+     */
+    public function setSequenceNumber($sequenceNumber)
+    {
+        $this->values['SequenceNumber'] = $sequenceNumber;
+        return $this;
+    }
+
+    /**
+     * Specifies the contents of this retrieved artifact part.
+     *
+     * @param string $contents
+     * @return $this
+     */
+    public function setContents($contents)
+    {
+        $this->values['Contents'] = $contents;
+        return $this;
+    }
+}

src/FedEx/AsyncService/ComplexType/ArtifactRetrievalFilter.php

@@ -0,0 +1,62 @@
+<?php
+namespace FedEx\AsyncService\ComplexType;
+
+use FedEx\AbstractComplexType;
+
+/**
+ * Specifies the details about the criteria used for artifact selection during retrieval.
+ *
+ * @author      Jeremy Dunn <[email protected]>
+ * @package     PHP FedEx API wrapper
+ * @subpackage  ASync Service
+ *
+ * @property string $AccessReference
+ * @property \FedEx\AsyncService\SimpleType\ArtifactType|string $Type
+ * @property string $ReferenceId
+
+ */
+class ArtifactRetrievalFilter extends AbstractComplexType
+{
+    /**
+     * Name of this complex type
+     *
+     * @var string
+     */
+    protected $name = 'ArtifactRetrievalFilter';
+
+    /**
+     * Set AccessReference
+     *
+     * @param string $accessReference
+     * @return $this
+     */
+    public function setAccessReference($accessReference)
+    {
+        $this->values['AccessReference'] = $accessReference;
+        return $this;
+    }
+
+    /**
+     * Set Type
+     *
+     * @param \FedEx\AsyncService\SimpleType\ArtifactType|string $type
+     * @return $this
+     */
+    public function setType($type)
+    {
+        $this->values['Type'] = $type;
+        return $this;
+    }
+
+    /**
+     * Set ReferenceId
+     *
+     * @param string $referenceId
+     * @return $this
+     */
+    public function setReferenceId($referenceId)
+    {
+        $this->values['ReferenceId'] = $referenceId;
+        return $this;
+    }
+}

src/FedEx/AsyncService/ComplexType/ClientDetail.php

@@ -0,0 +1,101 @@
+<?php
+namespace FedEx\AsyncService\ComplexType;
+
+use FedEx\AbstractComplexType;
+
+/**
+ * Descriptive data for the client submitting a transaction.
+ *
+ * @author      Jeremy Dunn <[email protected]>
+ * @package     PHP FedEx API wrapper
+ * @subpackage  ASync Service
+ *
+ * @property string $AccountNumber
+ * @property string $MeterNumber
+ * @property string $MeterInstance
+ * @property string $IntegratorId
+ * @property \FedEx\AsyncService\SimpleType\ExpressRegionCode|string $Region
+ * @property Localization $Localization
+
+ */
+class ClientDetail extends AbstractComplexType
+{
+    /**
+     * Name of this complex type
+     *
+     * @var string
+     */
+    protected $name = 'ClientDetail';
+
+    /**
+     * The FedEx account number associated with this transaction.
+     *
+     * @param string $accountNumber
+     * @return $this
+     */
+    public function setAccountNumber($accountNumber)
+    {
+        $this->values['AccountNumber'] = $accountNumber;
+        return $this;
+    }
+
+    /**
+     * This number is assigned by FedEx and identifies the unique device from which the request is originating
+     *
+     * @param string $meterNumber
+     * @return $this
+     */
+    public function setMeterNumber($meterNumber)
+    {
+        $this->values['MeterNumber'] = $meterNumber;
+        return $this;
+    }
+
+    /**
+     * Set MeterInstance
+     *
+     * @param string $meterInstance
+     * @return $this
+     */
+    public function setMeterInstance($meterInstance)
+    {
+        $this->values['MeterInstance'] = $meterInstance;
+        return $this;
+    }
+
+    /**
+     * Only used in transactions which require identification of the FedEx Office integrator.
+     *
+     * @param string $integratorId
+     * @return $this
+     */
+    public function setIntegratorId($integratorId)
+    {
+        $this->values['IntegratorId'] = $integratorId;
+        return $this;
+    }
+
+    /**
+     * Indicates the region from which the transaction is submitted.
+     *
+     * @param \FedEx\AsyncService\SimpleType\ExpressRegionCode|string $region
+     * @return $this
+     */
+    public function setRegion($region)
+    {
+        $this->values['Region'] = $region;
+        return $this;
+    }
+
+    /**
+     * The language to be used for human-readable Notification.localizedMessages in responses to the request containing this ClientDetail object. Different requests from the same client may contain different Localization data. (Contrast with TransactionDetail.localization, which governs data payload language/translation.)
+     *
+     * @param Localization $localization
+     * @return $this
+     */
+    public function setLocalization(Localization $localization)
+    {
+        $this->values['Localization'] = $localization;
+        return $this;
+    }
+}

src/FedEx/AsyncService/ComplexType/Localization.php

@@ -0,0 +1,49 @@
+<?php
+namespace FedEx\AsyncService\ComplexType;
+
+use FedEx\AbstractComplexType;
+
+/**
+ * Identifies the representation of human-readable text.
+ *
+ * @author      Jeremy Dunn <[email protected]>
+ * @package     PHP FedEx API wrapper
+ * @subpackage  ASync Service
+ *
+ * @property string $LanguageCode
+ * @property string $LocaleCode
+
+ */
+class Localization extends AbstractComplexType
+{
+    /**
+     * Name of this complex type
+     *
+     * @var string
+     */
+    protected $name = 'Localization';
+
+    /**
+     * Two-letter code for language (e.g. EN, FR, etc.)
+     *
+     * @param string $languageCode
+     * @return $this
+     */
+    public function setLanguageCode($languageCode)
+    {
+        $this->values['LanguageCode'] = $languageCode;
+        return $this;
+    }
+
+    /**
+     * Two-letter code for the region (e.g. us, ca, etc..).
+     *
+     * @param string $localeCode
+     * @return $this
+     */
+    public function setLocaleCode($localeCode)
+    {
+        $this->values['LocaleCode'] = $localeCode;
+        return $this;
+    }
+}