Skip to content

Commit 17debc1

Browse files
committed
Docs updated [skip ci]
1 parent b3df79d commit 17debc1

8 files changed

Lines changed: 39 additions & 39 deletions

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Turkish Airlines' TK API Unofficial PHP SDK
1+
# Turkish Airlines' TK API Unofficial PHP API
22

3-
[![Build Status](https://api.travis-ci.org/mkorkmaz/tk-api-php-sdk.svg?branch=master)](https://travis-ci.org/mkorkmaz/tk-api-php-sdk)
4-
[![Coverage Status](https://coveralls.io/repos/github/mkorkmaz/tk-api-php-sdk/badge.svg?branch=master)](https://coveralls.io/github/mkorkmaz/tk-api-php-sdk?branch=master)
5-
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mkorkmaz/tk-api-php-sdk/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/mkorkmaz/tk-api-php-sdk/?branch=master)
3+
[![Build Status](https://api.travis-ci.org/mkorkmaz/tk-api-php-client.svg?branch=master)](https://travis-ci.org/mkorkmaz/tk-api-php-client)
4+
[![Coverage Status](https://coveralls.io/repos/github/mkorkmaz/tk-api-php-client/badge.svg?branch=master)](https://coveralls.io/github/mkorkmaz/tk-api-php-client?branch=master)
5+
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mkorkmaz/tk-api-php-client/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/mkorkmaz/tk-api-php-client/?branch=master)
66

77
See the official documentation at [Turkish Airlines Developer Portal](https://developer.turkishairlines.com/)
88

@@ -12,7 +12,7 @@ To use this library, one has to create a developer account on Developer Portal a
1212
### Installation
1313

1414
```bash
15-
composer require mkorkmaz/tk-api-php-sdk
15+
composer require mkorkmaz/tk-api-php-client
1616
```
1717

1818
### Configuration
@@ -29,7 +29,7 @@ Use https://api.turkishairlines.com/test as your api test url during development
2929
<?php
3030

3131
include 'vendor/autoload.php';
32-
use TK\SDK\ClientBuilder;
32+
use TK\API\ClientBuilder;
3333

3434
$client = ClientBuilder::create()
3535
->setEnvironment(getenv('TK_API_URL'), getenv('TK_API_KEY'), getenv('TK_API_SECRET'))
@@ -41,4 +41,4 @@ $client = ClientBuilder::create()
4141
[See the list of endpoints](docs/endpoints/index.md)
4242
### Disclaimer
4343

44-
This SDK is not officially recognized by Turkish Airlines.
44+
This API is not officially recognized by Turkish Airlines.

docs/endpoints/CalculateAwardMilesWithTax.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ $this->client->calculateAwardMilesWithTax($calculateAwardMilesWithTaxParameters)
2020
```php
2121
<?php
2222

23-
use TK\SDK\ValueObject\Factory\CalculateAwardMilesWithTaxParametersFactory;
23+
use TK\API\ValueObject\Factory\CalculateAwardMilesWithTaxParametersFactory;
2424

2525
$json =<<<JSON
2626
{
@@ -47,7 +47,7 @@ You can build an array that is basically json_encode version of the object menti
4747
```php
4848
<?php
4949

50-
use TK\SDK\ValueObject\Factory\CalculateAwardMilesWithTaxParametersFactory;
50+
use TK\API\ValueObject\Factory\CalculateAwardMilesWithTaxParametersFactory;
5151

5252
$parameterObject = CalculateAwardMilesWithTaxParametersFactory::createFromArray($parametersArray);
5353

@@ -60,7 +60,7 @@ $response = $client->calculateAwardMilesWithTax($parameterObject);
6060
```php
6161
<?php
6262

63-
use TK\SDK\ValueObject\CalculateAwardMilesWithTaxParameters;
63+
use TK\API\ValueObject\CalculateAwardMilesWithTaxParameters;
6464

6565
$departureDate = gmdate('Y-m-d H:i:s', strtotime('-4 days'));
6666

docs/endpoints/CalculateFlightMiles.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ $this->client->calculateFlightMiles($calculateFlightMilesParameters);
2020
```php
2121
<?php
2222

23-
use TK\SDK\ValueObject\Factory\CalculateFlightMilesParametersFactory;
23+
use TK\API\ValueObject\Factory\CalculateFlightMilesParametersFactory;
2424

2525
$json =<<<JSON
2626
{
@@ -46,7 +46,7 @@ You can build an array that is basically json_encode version of the object menti
4646
```php
4747
<?php
4848

49-
use TK\SDK\ValueObject\Factory\CalculateFlightMilesParametersFactory;
49+
use TK\API\ValueObject\Factory\CalculateFlightMilesParametersFactory;
5050

5151
$parameterObject = CalculateFlightMilesParametersFactory::createFromArray($parametersArray);
5252

@@ -59,7 +59,7 @@ $response = $client->calculateFlightMiles($parameterObject);
5959
```php
6060
<?php
6161

62-
use TK\SDK\ValueObject\CalculateFlightMilesParameters;
62+
use TK\API\ValueObject\CalculateFlightMilesParameters;
6363

6464
$flightDate = gmdate('Y-m-d H:i:s', strtotime('+4 days'));
6565

docs/endpoints/GetAvailability.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ $client->getAvailability($getAvailabilityParametersObject);
2020
```php
2121
<?php
2222

23-
use TK\SDK\ValueObject\Factory\GetAvailabilityParametersFactory;
23+
use TK\API\ValueObject\Factory\GetAvailabilityParametersFactory;
2424

2525
$json =<<<JSON
2626
{
@@ -103,7 +103,7 @@ You can build an array that is basically json_encode version of the object menti
103103
```php
104104
<?php
105105

106-
use TK\SDK\ValueObject\Factory\GetAvailabilityParametersFactory;
106+
use TK\API\ValueObject\Factory\GetAvailabilityParametersFactory;
107107

108108
$getAvailabilityParameters = GetAvailabilityParametersFactory::createFromArray($parametersArray);
109109

@@ -117,11 +117,11 @@ $response = $client->getAvailability($getAvailabilityParameters);
117117
<?php
118118

119119
use DateTimeImmutable;
120-
use TK\SDK\ValueObject\Location;
121-
use TK\SDK\ValueObject\DepartureDateTime;
122-
use TK\SDK\ValueObject\OriginDestinationInformation;
123-
use TK\SDK\ValueObject\PassengerTypeQuantity;
124-
use TK\SDK\ValueObject\GetAvailabilityParameters;
120+
use TK\API\ValueObject\Location;
121+
use TK\API\ValueObject\DepartureDateTime;
122+
use TK\API\ValueObject\OriginDestinationInformation;
123+
use TK\API\ValueObject\PassengerTypeQuantity;
124+
use TK\API\ValueObject\GetAvailabilityParameters;
125125

126126
$departureTime = gmdate('Y-m-d H:i:s', strtotime('+4 days'));
127127
$departureDateTime = (new DepartureDateTime(

docs/endpoints/GetFareFamilyList.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ $this->client->getFareFamilyList($getFareFamilyListParameters);
2020
```php
2121
<?php
2222

23-
use TK\SDK\ValueObject\Factory\GetFareFamilyListParametersFactory;
23+
use TK\API\ValueObject\Factory\GetFareFamilyListParametersFactory;
2424

2525
$json =<<<JSON
2626
{
@@ -44,7 +44,7 @@ You can build an array that is basically json_encode version of the object menti
4444
```php
4545
<?php
4646

47-
use TK\SDK\ValueObject\Factory\GetFareFamilyListParametersFactory;
47+
use TK\API\ValueObject\Factory\GetFareFamilyListParametersFactory;
4848

4949
$parameterObject = GetFareFamilyListParametersFactory::createFromArray($parametersArray);
5050

@@ -56,12 +56,12 @@ $response = $client->getFareFamilyList($parameterObject);
5656
```php
5757
<?php
5858

59-
use TK\SDK\ValueObject\GetFareFamilyListParameters;
59+
use TK\API\ValueObject\GetFareFamilyListParameters;
6060

6161
$getFareFamilyListParameters = (new GetFareFamilyListParameters())
6262
->withAirportIataCode('IST')
6363
->withMilesRequest();
6464

6565
$response = $this->client->getFareFamilyList($getFareFamilyListParameters);
6666

67-
```
67+
```

docs/endpoints/GetPortList.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ $client->getPortList($getPortListParametersObject);
2020
```php
2121
<?php
2222

23-
use TK\SDK\ValueObject\Factory\GetPortListParametersFactory;
23+
use TK\API\ValueObject\Factory\GetPortListParametersFactory;
2424

2525
$json =<<<JSON
2626
{
@@ -40,7 +40,7 @@ You can build an array that is basically json_encode version of the object menti
4040
```php
4141
<?php
4242

43-
use TK\SDK\ValueObject\Factory\GetPortListParametersFactory;
43+
use TK\API\ValueObject\Factory\GetPortListParametersFactory;
4444

4545
$parameterObject = GetPortListParametersFactory::createFromArray($parametersArray);
4646

@@ -53,12 +53,12 @@ $response = $client->getPortList($parameterObject);
5353
```php
5454
<?php
5555

56-
use TK\SDK\ValueObject\GetPortListParameters;
56+
use TK\API\ValueObject\GetPortListParameters;
5757

5858
$getPortListParameters = (new GetPortListParameters(
5959
GetPortListParameters::AIRLINE_CODE_TURKISH_AIRLINES
6060
))->withLanguageCode(GetPortListParameters::LANGUAGE_CODE_EN);
6161

6262
$response = $this->client->getPortList($getPortListParameters);
6363

64-
```
64+
```

docs/endpoints/GetTimetable.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ $client->getTimetable($getTimetableParametersObject);
2020
```php
2121
<?php
2222

23-
use TK\SDK\ValueObject\Factory\GetTimetableParametersFactory;
23+
use TK\API\ValueObject\Factory\GetTimetableParametersFactory;
2424

2525
$jsonQuery =<<<JSON
2626
{
@@ -64,7 +64,7 @@ You can build an array that is basically json_encode version of the object menti
6464
```php
6565
<?php
6666

67-
use TK\SDK\ValueObject\Factory\GetTimetableParametersFactory;
67+
use TK\API\ValueObject\Factory\GetTimetableParametersFactory;
6868

6969
$getTimetableParametersObject = GetTimetableParametersFactory::createFromArray($parametersArray);
7070

@@ -78,11 +78,11 @@ $response = $client->getTimetable($getTimetableParametersObject);
7878
<?php
7979

8080
use DateTimeImmutable;
81-
use TK\SDK\ValueObject\Location;
82-
use TK\SDK\ValueObject\DepartureDateTime;
83-
use TK\SDK\ValueObject\OriginDestinationInformation;
84-
use TK\SDK\ValueObject\AirScheduleRQ;
85-
use TK\SDK\ValueObject\GetTimetableParameters;
81+
use TK\API\ValueObject\Location;
82+
use TK\API\ValueObject\DepartureDateTime;
83+
use TK\API\ValueObject\OriginDestinationInformation;
84+
use TK\API\ValueObject\AirScheduleRQ;
85+
use TK\API\ValueObject\GetTimetableParameters;
8686

8787
$originLocation = new Location('IST', Location::MULTIPLE_AIRPORT_TRUE);
8888
$destinationLocation = new Location('JFK', Location::MULTIPLE_AIRPORT_TRUE);

docs/endpoints/RetrieveReservationDetail.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ $this->client->retrieveReservationDetail($retrieveReservationDetailParameters);
2020
```php
2121
<?php
2222

23-
use TK\SDK\ValueObject\Factory\RetrieveReservationDetailParametersFactory;
23+
use TK\API\ValueObject\Factory\RetrieveReservationDetailParametersFactory;
2424

2525
$json =<<<JSON
2626
{
@@ -40,7 +40,7 @@ You can build an array that is basically json_encode version of the object menti
4040
```php
4141
<?php
4242

43-
use TK\SDK\ValueObject\Factory\RetrieveReservationDetailParametersFactory;
43+
use TK\API\ValueObject\Factory\RetrieveReservationDetailParametersFactory;
4444

4545
$parameterObject = RetrieveReservationDetailParametersFactory::createFromArray($parametersArray);
4646

@@ -54,7 +54,7 @@ $response = $client->retrieveReservationDetail($parameterObject);
5454
```php
5555
<?php
5656

57-
use TK\SDK\ValueObject\RetrieveReservationDetailParameters;
57+
use TK\API\ValueObject\RetrieveReservationDetailParameters;
5858

5959
$retrieveReservationDetailParameters = new RetrieveReservationDetailParameters(
6060
'TT8VN8',
@@ -63,4 +63,4 @@ $retrieveReservationDetailParameters = new RetrieveReservationDetailParameters(
6363

6464
$response = $this->client->retrieveReservationDetail($retrieveReservationDetailParameters);
6565

66-
```
66+
```

0 commit comments

Comments
 (0)