Add Fare_TLAGetFareRules message

CHANGELOG.md

@@ -1,4 +1,6 @@
 ## Unreleased
+* Implemented ``Fare_TLAGetFareRules``
+* Added ``Dockerfile`` for local development
 
 ## Release 1.13.0 (5 Apr 2021)
 * Add support for multiple pax types in Fare_MasterPricerTravelBoardSearch (https://github.com/amabnl/amadeus-ws-client/pull/432) - Artem Zakharchenko

docker/20-xdebug.ini

@@ -0,0 +1,8 @@
+xdebug.mode=debug
+xdebug.client_port=9000
+xdebug.idekey=xdebug
+xdebug.discover_client_host=1
+; we would receive errors from xdebug if we use the cli
+; if you need xdebug logs, change this to https://xdebug.org/docs/all_settings#log_level
+; @see https://stackoverflow.com/questions/65213171/disable-xdebug-3-could-not-connect-message-in-cli
+xdebug.log_level=0

docker/Dockerfile

@@ -0,0 +1,19 @@
+FROM php:7.4-fpm-alpine3.16
+
+RUN apk upgrade --no-cache --ignore alpine-baselayout \
+ && apk --no-cache add git libzip-dev libxml2-dev libxslt-dev
+
+RUN set -xe \
+ && apk add --no-cache --virtual .build-deps \
+ $PHPIZE_DEPS \
+ coreutils \
+ && docker-php-ext-install -j"$(/usr/bin/nproc)" zip soap xsl \
+ && pecl install xdebug \
+ && docker-php-ext-enable xdebug \
+ && apk del .build-deps
+
+COPY ./20-xdebug.ini /tmp/xdebug.ini
+RUN cat /tmp/xdebug.ini >> $PHP_INI_DIR/conf.d/docker-php-ext-xdebug.ini
+
+COPY . /var/www
+WORKDIR /var/www

docs/list-of-supported-messages.rst

@@ -32,6 +32,7 @@ This is the list of messages that are at least partially supported at this time:
 - Fare_CheckRules
 - Fare_GetFareRules
 - Fare_GetFareFamilyDescription
+- Fare_TLAGetFareRules
 - Air_MultiAvailability
 - Air_SellFromRecommendation
 - Air_FlightInfo

docs/samples.rst

@@ -1435,6 +1435,23 @@ Convert 200 Euro to US Dollars in the exchange rate of 25th December 2015 *(this
  ])
  );
 
+--------------------
+Fare_TLAGetFareRules
+--------------------
+
+Get fare rules for TLA carriers:
+
+.. code-block:: php
+
+ use Amadeus\Client\RequestOptions\FareTLAGetFareRulesOptions;
+
+ $rulesResponse = $client->fareTLAGetFareRules(
+ new FareTLAGetFareRulesOptions([
+ 'airlineCode' => '2U',
+ 'tariffClassId' => 'OB'
+ ])
+ );
+
 ***
 Air
 ***
@@ -4182,5 +4199,3 @@ that 'salesIndicator' option here named as 'documentInfo' and request doesn't ha
  ]);
 
  $salesReportResult = $client->salesReportsDisplayQueryReport($opt);
-
-

src/Amadeus/Client.php

@@ -812,6 +812,23 @@ public function fareGetFareRules(RequestOptions\FareGetFareRulesOptions $options
  return $this->callMessage($msgName, $options, $messageOptions);
  }
 
+ /**
+ * Fare_TLAGetFareRules
+ *
+ * @param RequestOptions\FareTLAGetFareRulesOptions $options
+ * @param array $messageOptions (OPTIONAL)
+ * @return Result
+ * @throws Client\InvalidMessageException
+ * @throws Client\RequestCreator\MessageVersionUnsupportedException
+ * @throws Exception
+ */
+ public function fareTLAGetFareRules(RequestOptions\FareTLAGetFareRulesOptions $options, $messageOptions = [])
+ {
+ $msgName = 'Fare_TLAGetFareRules';
+
+ return $this->callMessage($msgName, $options, $messageOptions);
+ }
+
  /**
  * Fare_ConvertCurrency
  *

src/Amadeus/Client/RequestCreator/Converter/Fare/TLAGetFareRulesConv.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Amadeus\Client\RequestCreator\Converter\Fare;
+
+use Amadeus\Client\RequestCreator\Converter\BaseConverter;
+use Amadeus\Client\RequestOptions\FareTLAGetFareRulesOptions;
+use Amadeus\Client\Struct;
+
+class TLAGetFareRulesConv extends BaseConverter
+{
+
+ /**
+ * @param FareTLAGetFareRulesOptions $requestOptions
+ * @param int|string $version
+ * @return Struct\Fare\TLAGetFareRules
+ */
+
+ /**
+ * @param FareTLAGetFareRulesOptions $requestOptions
+ * @param string|int $version
+ * @return Struct\Fare\TLAGetFareRules
+ */
+ public function convert($requestOptions, $version)
+ {
+ return new Struct\Fare\TLAGetFareRules($requestOptions);
+ }
+}

src/Amadeus/Client/RequestOptions/FareTLAGetFareRulesOptions.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Amadeus\Client\RequestOptions;
+
+class FareTLAGetFareRulesOptions extends Base
+{
+ /**
+ * @var string
+ */
+ public $airlineCode;
+
+ /**
+ * @var string
+ */
+ public $tariffClassId;
+}

src/Amadeus/Client/ResponseHandler/Fare/HandlerTLAGetFareRules.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Amadeus\Client\ResponseHandler\Fare;
+
+use Amadeus\Client\ResponseHandler\StandardResponseHandler;
+use Amadeus\Client\Session\Handler\SendResult;
+
+class HandlerTLAGetFareRules extends StandardResponseHandler
+{
+ public function analyze(SendResult $response)
+ {
+ return $this->analyzeSimpleResponseErrorCodeAndMessage($response);
+ }
+}

src/Amadeus/Client/Struct/Fare/MessageFunctionInfo.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Amadeus\Client\Struct\Fare;
+
+class MessageFunctionInfo
+{
+ /**
+ * @var MessageFunctionDetails
+ */
+ public $messageFunctionDetails;
+
+ /**
+ * Create msgType
+ *
+ * @param string|null $messageFunction
+ */
+ public function __construct($messageFunction = null)
+ {
+ $this->messageFunctionDetails = new MessageFunctionDetails($messageFunction);
+ }
+}

src/Amadeus/Client/Struct/Fare/TLAGetFareRules.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Amadeus\Client\Struct\Fare;
+
+use Amadeus\Client\RequestOptions\FareTLAGetFareRulesOptions;
+use Amadeus\Client\Struct\BaseWsMessage;
+use Amadeus\Client\Struct\Fare\TLAGetFareRules\FareBasisInfo;
+
+class TLAGetFareRules extends BaseWsMessage
+{
+ public $messageFunctionInfo;
+
+ public $fareBasisInfo;
+
+ /**
+ * @param FareTLAGetFareRulesOptions $options
+ */
+ public function __construct(FareTLAGetFareRulesOptions $options)
+ {
+ $this->messageFunctionInfo = new MessageFunctionInfo(MessageFunctionDetails::FARE_DISPLAY_RULES);
+ $this->loadFareBasisInfo($options);
+ }
+
+ private function loadFareBasisInfo(FareTLAGetFareRulesOptions $options)
+ {
+ $this->fareBasisInfo = new FareBasisInfo($options->tariffClassId, $options->airlineCode);
+ }
+}

src/Amadeus/Client/Struct/Fare/TLAGetFareRules/CompanyDetails.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Amadeus\Client\Struct\Fare\TLAGetFareRules;
+
+class CompanyDetails
+{
+ const COMPANY_INDUSTRY_CAR_RENTAL = '7CC';
+ const COMPANY_INDUSTRY_HOTEL_CHAINS = '7HH';
+
+ /**
+ * @var string
+ */
+ public $marketingCompany;
+
+ /**
+ * CompanyDetails constructor.
+ *
+ * @param string $marketingCompany
+ */
+ public function __construct($marketingCompany)
+ {
+ $this->marketingCompany = $marketingCompany;
+ }
+}

src/Amadeus/Client/Struct/Fare/TLAGetFareRules/FareBasisDetails.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Amadeus\Client\Struct\Fare\TLAGetFareRules;
+
+class FareBasisDetails
+{
+ /**
+ * @var string
+ */
+ public $tariffClassId;
+
+ /**
+ * @var CompanyDetails
+ */
+ public $companyDetails;
+
+ /**
+ * @param string $tariffClassId
+ * @param string $marketingCompany
+ */
+ public function __construct($tariffClassId, $marketingCompany)
+ {
+ $this->tariffClassId = $tariffClassId;
+ $this->companyDetails = new CompanyDetails($marketingCompany);
+ }
+}

src/Amadeus/Client/Struct/Fare/TLAGetFareRules/FareBasisInfo.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Amadeus\Client\Struct\Fare\TLAGetFareRules;
+
+class FareBasisInfo
+{
+ /**
+ * @var FareBasisDetails
+ */
+ public $fareBasisDetails;
+
+ /**
+ * @param string $tariffClassId
+ * @param string $marketingCompany
+ */
+ public function __construct($tariffClassId, $marketingCompany)
+ {
+ $this->fareBasisDetails = new FareBasisDetails($tariffClassId, $marketingCompany);
+ }
+}

tests/Amadeus/Client/ResponseHandler/BaseTest.php

@@ -1971,4 +1971,17 @@ public function testCanHandlePNRSplit()
  $this->assertEquals(Result::STATUS_OK, $result->status);
  $this->assertEquals(0, count($result->messages));
  }
+
+ public function testCanHandleFareTLAGetFareRules()
+ {
+ $respHandler = new ResponseHandler\Base();
+
+ $sendResult = new SendResult();
+ $sendResult->responseXml = $this->getTestFile('dummyFareTLAGetFareRulesResponse.txt');
+
+ $result = $respHandler->analyzeResponse($sendResult, 'Fare_TLAGetFareRules');
+
+ $this->assertEquals(Result::STATUS_OK, $result->status);
+ $this->assertEquals(0, count($result->messages));
+ }
 }