Skip to content

Commit

Permalink
Ссылки на документацию в методах Services, файловые phpdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
jhaoda committed Sep 5, 2019
1 parent a58aeac commit 37d52ef
Show file tree
Hide file tree
Showing 11 changed files with 114 additions and 1 deletion.
9 changes: 9 additions & 0 deletions src/Dispatching/Endpoints/Services/Responses/Address.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
<?php

/**
* This file is part of RussianPost SDK package.
*
* © Appwilio (http://appwilio.com), JhaoDa (https://github.com/jhaoda)
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

declare(strict_types=1);

namespace Appwilio\RussianPostSDK\Dispatching\Endpoints\Services\Responses;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
<?php

/**
* This file is part of RussianPost SDK package.
*
* © Appwilio (http://appwilio.com), JhaoDa (https://github.com/jhaoda)
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

declare(strict_types=1);

namespace Appwilio\RussianPostSDK\Dispatching\Endpoints\Services\Responses;
Expand Down
23 changes: 23 additions & 0 deletions src/Dispatching/Endpoints/Services/Services.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
<?php

/**
* This file is part of RussianPost SDK package.
*
* © Appwilio (http://appwilio.com), JhaoDa (https://github.com/jhaoda)
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

declare(strict_types=1);

namespace Appwilio\RussianPostSDK\Dispatching\Endpoints\Services;
Expand Down Expand Up @@ -31,6 +40,8 @@ public function __construct(ApiClient $client)
/**
* Нормализация телефона(ов).
*
* @link https://otpravka.pochta.ru/specification#/nogroup-normalization_phone
*
* @param NormalizePhoneRequest $request
*
* @return iterable|Phone[]
Expand All @@ -43,6 +54,8 @@ public function normalizePhone(NormalizePhoneRequest $request): iterable
/**
* Нормализация адреса(ов).
*
* @link https://otpravka.pochta.ru/specification#/nogroup-normalization_adress
*
* @param NormalizeAddressRequest $request
*
* @return iterable|Address[]
Expand All @@ -55,6 +68,8 @@ public function normalizeAddress(NormalizeAddressRequest $request): iterable
/**
* Нормализация ФИО.
*
* @link https://otpravka.pochta.ru/specification#/nogroup-normalization_fio
*
* @param NormalizeFioRequest $request
*
* @return iterable|Fio[]
Expand All @@ -67,6 +82,8 @@ public function normalizeFio(NormalizeFioRequest $request): iterable
/**
* Расчёт стоимости доставки.
*
* @link https://otpravka.pochta.ru/specification#/nogroup-rate_calculate
*
* @param CalculationRequest $request
*
* @return CalculationResponse
Expand All @@ -77,6 +94,10 @@ public function calculate(CalculationRequest $request): CalculationResponse
}

/**
* Получение баланса расчётного счёта.
*
* @link https://otpravka.pochta.ru/specification#/nogroup-counterpart_balance
*
* @return BalanceReponse
*/
public function getBalance(): BalanceReponse
Expand All @@ -87,6 +108,8 @@ public function getBalance(): BalanceReponse
/**
* Проверка благонадёжности получателя(ей).
*
* @link https://otpravka.pochta.ru/specification#/nogroup-unreliable_recipient
*
* @param CheckRecipientRequest $request
*
* @return iterable|Recipient[]
Expand Down
9 changes: 9 additions & 0 deletions src/Dispatching/Enum/AddressType.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
<?php

/**
* This file is part of RussianPost SDK package.
*
* © Appwilio (http://appwilio.com), JhaoDa (https://github.com/jhaoda)
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

declare(strict_types=1);

namespace Appwilio\RussianPostSDK\Dispatching\Enum;
Expand Down
9 changes: 9 additions & 0 deletions src/Dispatching/Enum/MailCategory.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
<?php

/**
* This file is part of RussianPost SDK package.
*
* © Appwilio (http://appwilio.com), JhaoDa (https://github.com/jhaoda)
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

declare(strict_types=1);

namespace Appwilio\RussianPostSDK\Dispatching\Enum;
Expand Down
9 changes: 9 additions & 0 deletions src/Dispatching/Enum/MailEntryType.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
<?php

/**
* This file is part of RussianPost SDK package.
*
* © Appwilio (http://appwilio.com), JhaoDa (https://github.com/jhaoda)
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

declare(strict_types=1);

namespace Appwilio\RussianPostSDK\Dispatching\Enum;
Expand Down
9 changes: 9 additions & 0 deletions src/Dispatching/Enum/MailType.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
<?php

/**
* This file is part of RussianPost SDK package.
*
* © Appwilio (http://appwilio.com), JhaoDa (https://github.com/jhaoda)
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

declare(strict_types=1);

namespace Appwilio\RussianPostSDK\Dispatching\Enum;
Expand Down
9 changes: 9 additions & 0 deletions src/Dispatching/Enum/PaymentType.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
<?php

/**
* This file is part of RussianPost SDK package.
*
* © Appwilio (http://appwilio.com), JhaoDa (https://github.com/jhaoda)
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

declare(strict_types=1);

namespace Appwilio\RussianPostSDK\Dispatching\Enum;
Expand Down
9 changes: 9 additions & 0 deletions src/Dispatching/Http/ApiClient.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
<?php

/**
* This file is part of RussianPost SDK package.
*
* © Appwilio (http://appwilio.com), JhaoDa (https://github.com/jhaoda)
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

declare(strict_types=1);

namespace Appwilio\RussianPostSDK\Dispatching\Http;
Expand Down
11 changes: 10 additions & 1 deletion src/Dispatching/Http/ArrayOf.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
<?php

/**
* This file is part of RussianPost SDK package.
*
* © Appwilio (http://appwilio.com), JhaoDa (https://github.com/jhaoda)
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

declare(strict_types=1);

namespace Appwilio\RussianPostSDK\Dispatching\Http;
Expand All @@ -18,4 +27,4 @@ public function getType(): string
{
return $this->type;
}
}
}
9 changes: 9 additions & 0 deletions src/Dispatching/Http/Authorization.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
<?php

/**
* This file is part of RussianPost SDK package.
*
* © Appwilio (http://appwilio.com), JhaoDa (https://github.com/jhaoda)
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

declare(strict_types=1);

namespace Appwilio\RussianPostSDK\Dispatching\Http;
Expand Down

0 comments on commit 37d52ef

Please sign in to comment.