Implemented Ticket_UpdateRefund. For now only waiver codes are suppor…

…ted.

CHANGELOG.md

@@ -4,6 +4,7 @@ https://github.com/amabnl/amadeus-ws-client/pull/344:
 * Added support to add freeText for payment type Cash and CC in ``Pnr_AddMultiElements``
 * Added support for "ZapOff" in ``Fare_PricePnrWithBookingClass``
 * Added support for "Fare Misc TKT Information", "Fare Endorsement", "Fare Endorsement" , "Fare Misc Information" in ``Pnr_AddMultiElements``
+* Implemented ``Ticket_UpdateRefund`` (https://github.com/amabnl/amadeus-ws-client/pull/398) - Vladimir Kikot
 
 # Release 1.10.0 (27 May 2020)
 * Bugfix for a SOAP-ERROR in ``DocIssuance_IssueMiscellaneousDocuments`` (https://github.com/amabnl/amadeus-ws-client/pull/359) - Artem Zakharchenko

docs/list-of-supported-messages.rst

@@ -57,6 +57,7 @@ This is the list of messages that are at least partially supported at this time:
 - Ticket_ProcessEDoc
 - Ticket_ProcessETicket
 - Ticket_InitRefund
+- Ticket_UpdateRefund
 - Ticket_IgnoreRefund
 - Ticket_ProcessRefund
 - DocIssuance_IssueTicket

docs/samples.rst

@@ -2580,6 +2580,22 @@ Initiate Automated Refund:
         ])
     );
 
+---------------------------
+Ticket_UpdateRefund
+---------------------------
+
+Apply waiver code (for now only waiver codes are supported):
+
+.. code-block:: php
+
+    use Amadeus\Client\RequestOptions\TicketUpdateRefundOptions;
+
+    $response = $client->ticketUpdateRefund(
+        new TicketUpdateRefundOptions([
+            'waiverCode' => 'TESTWAIVER11',
+            'contractBundleId' => 1,
+        ])
+    );
 
 ---------------------------
 Ticket_IgnoreRefund

src/Amadeus/Client.php

@@ -1530,6 +1530,25 @@ public function ticketProcessRefund(
         return $this->callMessage($msgName, $options, $messageOptions);
     }
 
+    /**
+     * Ticket_UpdateRefund
+     *
+     * @param RequestOptions\TicketUpdateRefundOptions $options
+     * @param array $messageOptions (OPTIONAL)
+     * @return Result
+     * @throws Client\InvalidMessageException
+     * @throws Client\RequestCreator\MessageVersionUnsupportedException
+     * @throws Exception
+     */
+    public function ticketUpdateRefund(
+        RequestOptions\TicketUpdateRefundOptions $options,
+        $messageOptions = []
+    ) {
+        $msgName = 'Ticket_UpdateRefund';
+
+        return $this->callMessage($msgName, $options, $messageOptions);
+    }
+
     /**
      * FOP_CreateFormOfPayment
      *

src/Amadeus/Client/RequestCreator/Converter/Ticket/UpdateRefundConv.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * amadeus-ws-client
+ *
+ * Copyright 2015 Amadeus Benelux NV
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @package Amadeus
+ * @license https://opensource.org/licenses/Apache-2.0 Apache 2.0
+ */
+
+namespace Amadeus\Client\RequestCreator\Converter\Ticket;
+
+use Amadeus\Client\RequestCreator\Converter\BaseConverter;
+use Amadeus\Client\RequestOptions\TicketUpdateRefundOptions;
+use Amadeus\Client\Struct;
+
+/**
+ * Ticket_UpdateRefund request converter
+ *
+ * @package Amadeus\Client\RequestCreator\Converter\Ticket
+ * @author Vladimir Kikot <shoxyoyo@gmail.com>
+ */
+class UpdateRefundConv extends BaseConverter
+{
+    /**
+     * @param TicketUpdateRefundOptions $requestOptions
+     * @param int|string $version
+     * @return Struct\Ticket\UpdateRefund
+     */
+    public function convert($requestOptions, $version)
+    {
+        return new Struct\Ticket\UpdateRefund($requestOptions);
+    }
+}

src/Amadeus/Client/RequestOptions/TicketUpdateRefundOptions.php

@@ -0,0 +1,38 @@
+<?php
+/**
+ * amadeus-ws-client
+ *
+ * Copyright 2015 Amadeus Benelux NV
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @package Amadeus
+ * @license https://opensource.org/licenses/Apache-2.0 Apache 2.0
+ */
+
+namespace Amadeus\Client\RequestOptions;
+
+/**
+ * TicketUpdateRefundOptions Request Options
+ *
+ * @package Amadeus\Client\RequestOptions
+ * @author Vladimir Kikot <shoxyoyo@gmail.com>
+ */
+class TicketUpdateRefundOptions extends Base
+{
+    /** @var int */
+    public $contractBundleId;
+
+    /** @var string */
+    public $waiverCode;
+}

src/Amadeus/Client/ResponseHandler/Ticket/HandlerUpdateRefund.php

@@ -0,0 +1,33 @@
+<?php
+/**
+ * amadeus-ws-client
+ *
+ * Copyright 2015 Amadeus Benelux NV
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @package Amadeus
+ * @license https://opensource.org/licenses/Apache-2.0 Apache 2.0
+ */
+
+namespace Amadeus\Client\ResponseHandler\Ticket;
+
+/**
+ * HandlerUpdateRefund
+ *
+ * @package Amadeus\Client\ResponseHandler\Ticket
+ * @author Vladimir Kikot <shoxyoyo@gmail.com>
+ */
+class HandlerUpdateRefund extends HandlerInitRefund
+{
+}

src/Amadeus/Client/Struct/Ticket/UpdateRefund.php

@@ -0,0 +1,51 @@
+<?php
+/**
+ * amadeus-ws-client
+ *
+ * Copyright 2015 Amadeus Benelux NV
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @package Amadeus
+ * @license https://opensource.org/licenses/Apache-2.0 Apache 2.0
+ */
+
+namespace Amadeus\Client\Struct\Ticket;
+
+use Amadeus\Client\RequestOptions\TicketUpdateRefundOptions;
+use Amadeus\Client\Struct\BaseWsMessage;
+use Amadeus\Client\Struct\Ticket\UpdateRefund\ContractBundle;
+
+/**
+ * UpdateRefund request structure
+ *
+ * @package Amadeus\Client\Struct\Ticket
+ * @author Vladimir Kikot <shoxyoyo@gmail.com>
+ */
+class UpdateRefund extends BaseWsMessage
+{
+    /** @var ContractBundle $ContractBundle */
+    public $ContractBundle;
+
+    public $Version = "3.000";
+
+    /**
+     * UpdateRefund constructor.
+     *
+     * @param TicketUpdateRefundOptions $options
+     */
+    public function __construct($options)
+    {
+        $this->ContractBundle = new ContractBundle($options->contractBundleId, $options->waiverCode);
+    }
+}

src/Amadeus/Client/Struct/Ticket/UpdateRefund/ContractBundle.php

@@ -0,0 +1,52 @@
+<?php
+/**
+ * amadeus-ws-client
+ *
+ * Copyright 2015 Amadeus Benelux NV
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @package Amadeus
+ * @license https://opensource.org/licenses/Apache-2.0 Apache 2.0
+ */
+
+namespace Amadeus\Client\Struct\Ticket\UpdateRefund;
+
+use Amadeus\Client\Struct\BaseWsMessage;
+
+/**
+ * ContractBundle request structure
+ *
+ * @package Amadeus\Client\Struct\Ticket\UpdateRefund
+ * @author Vladimir Kikot <shoxyoyo@gmail.com>
+ */
+class ContractBundle extends BaseWsMessage
+{
+    /** @var int */
+    public $ID;
+
+    /** @var WaiverCode */
+    public $WaiverCode;
+
+    /**
+     * ContractBundle constructor.
+     *
+     * @param int $id
+     * @param string $waiverCode
+     */
+    public function __construct($id, $waiverCode)
+    {
+        $this->ID = $id;
+        $this->WaiverCode = new WaiverCode($waiverCode);
+    }
+}

src/Amadeus/Client/Struct/Ticket/UpdateRefund/WaiverCode.php

@@ -0,0 +1,47 @@
+<?php
+/**
+ * amadeus-ws-client
+ *
+ * Copyright 2015 Amadeus Benelux NV
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @package Amadeus
+ * @license https://opensource.org/licenses/Apache-2.0 Apache 2.0
+ */
+
+namespace Amadeus\Client\Struct\Ticket\UpdateRefund;
+
+use Amadeus\Client\Struct\BaseWsMessage;
+
+/**
+ * WaiverCode request structure
+ *
+ * @package Amadeus\Client\Struct\Ticket\UpdateRefund
+ * @author Vladimir Kikot <shoxyoyo@gmail.com>
+ */
+class WaiverCode extends BaseWsMessage
+{
+    /** @var string */
+    public $Code;
+
+    /**
+     * WaiverCode constructor.
+     *
+     * @param string $waiverCode
+     */
+    public function __construct($waiverCode)
+    {
+        $this->Code = $waiverCode;
+    }
+}

tests/Amadeus/Client/ResponseHandler/BaseTest.php

@@ -1804,6 +1804,44 @@ public function testCanHandleUnknownTicketInitRefund()
         $this->assertEquals(Result::STATUS_UNKNOWN, $result->status);
     }
 
+    public function testCanHandleOkTicketUpdateRefund()
+    {
+        $respHandler = new ResponseHandler\Base();
+
+        $sendResult = new SendResult();
+        $sendResult->responseXml = $this->getTestFile('dummyTicketUpdateRefundResponse.txt');
+
+        $result = $respHandler->analyzeResponse($sendResult, 'Ticket_UpdateRefund');
+
+        $this->assertEquals(Result::STATUS_OK, $result->status);
+        $this->assertCount(0, $result->messages);
+    }
+
+    public function testCanHandleFailTicketUpdateRefund()
+    {
+        $respHandler = new ResponseHandler\Base();
+
+        $sendResult = new SendResult();
+        $sendResult->responseXml = $this->getTestFile('dummyTicketUpdateRefundFailResponse.txt');
+
+        $result = $respHandler->analyzeResponse($sendResult, 'Ticket_InitRefund');
+
+        $this->assertEquals(Result::STATUS_ERROR, $result->status);
+        $this->assertCount(1, $result->messages);
+    }
+
+    public function testCanHandleUnknownTicketUpdateRefund()
+    {
+        $respHandler = new ResponseHandler\Base();
+
+        $sendResult = new SendResult();
+        $sendResult->responseXml = $this->getTestFile('dummyTicketUpdateRefundUnknownResponse.txt');
+
+        $result = $respHandler->analyzeResponse($sendResult, 'Ticket_InitRefund');
+
+        $this->assertEquals(Result::STATUS_UNKNOWN, $result->status);
+    }
+
     public function testCanHandleOkTicketIgnoreRefund()
     {
         $respHandler = new ResponseHandler\Base();

tests/Amadeus/Client/ResponseHandler/testfiles/dummyTicketUpdateRefundFailResponse.txt

@@ -0,0 +1,14 @@
+<AMA_TicketUpdateRefundRS xmlns="http://xml.amadeus.com/2010/06/TicketGTP_v3"
+                          xmlns:ama="http://xml.amadeus.com/2010/06/Types_v2"
+                          xmlns:att="http://xml.amadeus.com/2010/06/TicketTypes_v2"
+                          xmlns:iata="http://www.iata.org/IATA/2007/00/IATA2010.1"
+                          xmlns:ota="http://www.opentravel.org/OTA/2003/05/OTA2010B"
+                          xmlns:xsd="http://www.w3.org/2001/XMLSchema" Version="3.000">
+    <GeneralReply>
+        <Errors>
+            <ama:Errors>
+                <ama:Error Type="000" Code="11004">NEED REFUND RECORD</ama:Error>
+            </ama:Errors>
+        </Errors>
+    </GeneralReply>
+</AMA_TicketUpdateRefundRS>