Implemented Ticket_DeleteTSMP message

CHANGELOG.md

@@ -1,5 +1,6 @@
 # Release 1.2.0 (Unreleased)
 * Request Creator split up in 1 dedicated class per message.
+* Implemented ``Ticket_DeleteTSMP``
 
 # Release 1.1.0 (19 October 2016)
 

docs/samples.rst

@@ -1202,6 +1202,45 @@ Delete the TST with number 2:
         ])
     );
 
+-----------------
+Ticket_DeleteTSMP
+-----------------
+
+Delete TSMs attached to passengers with tattoos 2 and 3:
+
+.. code-block:: php
+
+    use Amadeus\Client\RequestOptions\TicketDeleteTsmpOptions;
+
+    $deleteTstResult = $client->ticketDeleteTSMP(
+        new TicketDeleteTsmpOptions([
+            'paxTattoos' => [2, 3]
+        ])
+    );
+
+Delete TSMs attached to the infant of passenger with tattoo 1:
+
+.. code-block:: php
+
+    use Amadeus\Client\RequestOptions\TicketDeleteTsmpOptions;
+
+    $deleteTstResult = $client->ticketDeleteTSMP(
+        new TicketDeleteTsmpOptions([
+            'infantTattoos' => [1]
+        ])
+    );
+
+Delete TSMs for TSMs tattoo 2 and 4:
+
+.. code-block:: php
+
+    use Amadeus\Client\RequestOptions\TicketDeleteTsmpOptions;
+
+    $deleteTstResult = $client->ticketDeleteTSMP(
+        new TicketDeleteTsmpOptions([
+            'tsmTattoos' => [2, 4]
+        ])
+    );
 
 -----------------
 Ticket_DisplayTST

src/Amadeus/Client.php

@@ -791,6 +791,20 @@ public function ticketDeleteTST(RequestOptions\TicketDeleteTstOptions $options,
         return $this->callMessage($msgName, $options, $messageOptions);
     }
 
+    /**
+     * Ticket_DeleteTSMP
+     *
+     * @param RequestOptions\TicketDeleteTsmpOptions $options
+     * @param array $messageOptions (OPTIONAL)
+     * @return Result
+     */
+    public function ticketDeleteTSMP(RequestOptions\TicketDeleteTsmpOptions $options, $messageOptions = [])
+    {
+        $msgName = 'Ticket_DeleteTSMP';
+
+        return $this->callMessage($msgName, $options, $messageOptions);
+    }
+
     /**
      * Ticket_DisplayTST
      *

src/Amadeus/Client/RequestCreator/Converter/Ticket/DeleteTSMPConv.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\TicketDeleteTsmpOptions;
+use Amadeus\Client\Struct;
+
+/**
+ * Ticket_DeleteTSMP Request converter
+ *
+ * @package Amadeus\Client\RequestCreator\Converter\Ticket
+ * @author Dieter Devlieghere <dieter.devlieghere@benelux.amadeus.com>
+ */
+class DeleteTSMPConv extends BaseConverter
+{
+    /**
+     * @param TicketDeleteTsmpOptions $requestOptions
+     * @param int|string $version
+     * @return Struct\Ticket\DeleteTSMP
+     */
+    public function convert($requestOptions, $version)
+    {
+        return new Struct\Ticket\DeleteTSMP($requestOptions);
+    }
+}

src/Amadeus/Client/RequestOptions/TicketDeleteTsmpOptions.php

@@ -0,0 +1,55 @@
+<?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;
+
+/**
+ * TicketDeleteTsmpOptions
+ *
+ * @package Amadeus\Client\RequestOptions
+ * @author Dieter Devlieghere <dieter.devlieghere@benelux.amadeus.com>
+ */
+class TicketDeleteTsmpOptions extends Base
+{
+    /**
+     * List of TSM-P tattoos to delete
+     *
+     * @var int[]
+     */
+    public $tsmTattoos = [];
+
+    /**
+     * List of passenger tattoos for who to delete all TSMP's
+     *
+     * @var int[]
+     */
+    public $paxTattoos = [];
+
+    /**
+     * List of infant tattoos for who to delete all TSMP's
+     *
+     * (The tattoos you need to provide here are the parent passenger tattoos)
+     *
+     * @var int[]
+     */
+    public $infantTattoos = [];
+}

src/Amadeus/Client/ResponseHandler/Base.php

@@ -583,6 +583,15 @@ protected function analyzeTicketDeleteTSTResponse($response)
         return $this->analyzeTicketCreateTSTFromPricingResponse($response);
     }
 
+    /**
+     * @param SendResult $response Ticket_DeleteTSMP result
+     * @return Result
+     */
+    protected function analyzeTicketDeleteTSMPResponse($response)
+    {
+        return $this->analyzeSimpleResponseErrorCodeAndMessage($response);
+    }
+
     /**
      * @param SendResult $response Ticket_CreateTSTFromPricing result
      * @return Result

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

@@ -0,0 +1,48 @@
+<?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;
+
+/**
+ * CriteriaTattoo
+ *
+ * @package Amadeus\Client\Struct\Ticket
+ * @author Dieter Devlieghere <dieter.devlieghere@benelux.amadeus.com>
+ */
+class CriteriaTattoo
+{
+    /**
+     * @var ReferenceDetails
+     */
+    public $referenceDetails;
+
+    /**
+     * CriteriaTattoo constructor.
+     *
+     * @param string $type ReferenceDetails::TYPE_*
+     * @param string|int $value the tattoo
+     */
+    public function __construct($type, $value)
+    {
+        $this->referenceDetails = new ReferenceDetails($type, $value);
+    }
+}

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

@@ -0,0 +1,71 @@
+<?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\TicketDeleteTsmpOptions;
+use Amadeus\Client\Struct\BaseWsMessage;
+
+/**
+ * DeleteTSMP
+ *
+ * @package Amadeus\Client\Struct\Ticket
+ * @author Dieter Devlieghere <dieter.devlieghere@benelux.amadeus.com>
+ */
+class DeleteTSMP extends BaseWsMessage
+{
+    /**
+     * @var CriteriaTattoo[]
+     */
+    public $criteriaTattoo = [];
+
+    /**
+     * DeleteTSMP constructor.
+     *
+     * @param TicketDeleteTsmpOptions $params
+     */
+    public function __construct(TicketDeleteTsmpOptions $params)
+    {
+        foreach ($params->infantTattoos as $infantTattoo) {
+            $this->addCriteriaTattoo($infantTattoo, ReferenceDetails::TYPE_INFANT_PARENT_TATTOO);
+        }
+
+        foreach ($params->paxTattoos as $paxTattoo) {
+            $this->addCriteriaTattoo($paxTattoo, ReferenceDetails::TYPE_PASSENGER_TATTOO);
+        }
+
+        foreach ($params->tsmTattoos as $tsmTattoo) {
+            $this->addCriteriaTattoo($tsmTattoo, ReferenceDetails::TYPE_TSM_TATTOO);
+        }
+    }
+
+    /**
+     * Add a tattoo ref to the message
+     *
+     * @param string|int $tattoo
+     * @param string $type
+     */
+    protected function addCriteriaTattoo($tattoo, $type)
+    {
+        $this->criteriaTattoo[] = new CriteriaTattoo($type, $tattoo);
+    }
+}

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

@@ -0,0 +1,60 @@
+<?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;
+
+/**
+ * ReferenceDetails
+ *
+ * @package Amadeus\Client\Struct\Ticket
+ * @author Dieter Devlieghere <dieter.devlieghere@benelux.amadeus.com>
+ */
+class ReferenceDetails
+{
+    const TYPE_INFANT_PARENT_TATTOO = "INF";
+    const TYPE_PASSENGER_TATTOO = "PAX";
+    const TYPE_TSM_TATTOO = "TSM";
+
+    /**
+     * self::TYPE_*
+     *
+     * @var string
+     */
+    public $type;
+
+    /**
+     * @var string|int
+     */
+    public $value;
+
+    /**
+     * ReferenceDetails constructor.
+     *
+     * @param string $type
+     * @param int|string $value
+     */
+    public function __construct($type, $value)
+    {
+        $this->type = $type;
+        $this->value = $value;
+    }
+}

tests/Amadeus/Client/ResponseHandler/BaseTest.php

@@ -969,6 +969,21 @@ public function testCanHandleTicketDeleteTSTErrResponse()
         $this->assertEquals("NEED PNR", $result->messages[0]->text);
     }
 
+    public function testCanHandleTicketDeleteTSMPErrorResponse()
+    {
+        $respHandler = new ResponseHandler\Base();
+
+        $sendResult = new SendResult();
+        $sendResult->responseXml = $this->getTestFile('dummyTicketDeleteTsmpErrorResponse.txt');
+
+        $result = $respHandler->analyzeResponse($sendResult, 'Ticket_DeleteTSMP');
+
+        $this->assertEquals(Result::STATUS_ERROR, $result->status);
+        $this->assertEquals(1, count($result->messages));
+        $this->assertEquals('911', $result->messages[0]->code);
+        $this->assertEmpty($result->messages[0]->text);
+    }
+
     public function testCanHandleTicketDisplayTSTErrResponse()
     {
         $respHandler = new ResponseHandler\Base();