Skip to content

Commit

Permalink
Improve PHPDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
@webeweb
webeweb committed Mar 15, 2024
1 parent bc146d0 commit 9893886
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 18 deletions.
2 changes: 0 additions & 2 deletions src/Provider/AbstractProvider.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
namespace WBW\Library\SmsMode\Provider;

use GuzzleHttp\Client;
use GuzzleHttp\Exception\GuzzleException;
use InvalidArgumentException;
use Psr\Log\LoggerInterface;
use Throwable;
Expand Down Expand Up @@ -92,7 +91,6 @@ private function buildConfiguration(): array {
* @param mixed[] $postData The post data.
* @return string Returns the raw response.
* @throws InvalidArgumentException Throws an invalid argument exception if a parameter is missing.
* @throws GuzzleException Throws a Guzzle exception if an error occurs.
* @throws ApiException Throws an API exception if an error occurs.
*/
protected function callApi(AbstractRequest $request, array $queryData, array $postData = []): string {
Expand Down
16 changes: 0 additions & 16 deletions src/Provider/ApiProvider.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
namespace WBW\Library\SmsMode\Provider;

use GuzzleHttp\Exception\ClientException;
use GuzzleHttp\Exception\GuzzleException;
use InvalidArgumentException;
use WBW\Library\Provider\Exception\ApiException;
use WBW\Library\SmsMode\Request\AccountBalanceRequest;
Expand Down Expand Up @@ -61,7 +60,6 @@ class ApiProvider extends AbstractProvider {
* @param AccountBalanceRequest $request The account balance request.
* @return AccountBalanceResponse Returns the account balance response.
* @throws InvalidArgumentException Throws an invalid argument exception if a parameter is missing.
* @throws GuzzleException Throws a Guzzle exception if an error occurs.
* @throws ApiException Throws an API exception if an error occurs.
*/
public function accountBalance(AccountBalanceRequest $request): AccountBalanceResponse {
Expand All @@ -79,7 +77,6 @@ public function accountBalance(AccountBalanceRequest $request): AccountBalanceRe
* @param AddingContactRequest $request The adding contact request.
* @return AddingContactResponse Returns the adding contact response.
* @throws InvalidArgumentException Throws an invalid argument exception if a parameter is missing.
* @throws GuzzleException Throws a Guzzle exception if an error occurs.
* @throws ApiException Throws an API exception if an error occurs.
*/
public function addingContact(AddingContactRequest $request): AddingContactResponse {
Expand All @@ -97,7 +94,6 @@ public function addingContact(AddingContactRequest $request): AddingContactRespo
* @param CheckingSmsMessageStatusRequest $request The checking SMS message status request.
* @return CheckingSmsMessageStatusResponse Returns the checking SMS message status response.
* @throws InvalidArgumentException Throws an invalid argument exception if a parameter is missing.
* @throws GuzzleException Throws a Guzzle exception if an error occurs.
* @throws ApiException Throws an API exception if an error occurs.
*/
public function checkingSmsMessageStatus(CheckingSmsMessageStatusRequest $request): CheckingSmsMessageStatusResponse {
Expand All @@ -115,7 +111,6 @@ public function checkingSmsMessageStatus(CheckingSmsMessageStatusRequest $reques
* @param CreatingApiKeyRequest $request The creating API key request.
* @return CreatingApiKeyResponse Returns the creating API key response.
* @throws InvalidArgumentException Throws an invalid argument exception if a parameter is missing.
* @throws GuzzleException Throws a Guzzle exception if an error occurs.
* @throws ApiException Throws an API exception if an error occurs.
*/
public function creatingApiKey(CreatingApiKeyRequest $request): CreatingApiKeyResponse {
Expand Down Expand Up @@ -144,7 +139,6 @@ public function creatingApiKey(CreatingApiKeyRequest $request): CreatingApiKeyRe
* @param CreatingSubAccountRequest $request The creating sub-account request.
* @return CreatingSubAccountResponse Returns the creating sub-account response.
* @throws InvalidArgumentException Throws an invalid argument exception if a parameter is missing.
* @throws GuzzleException Throws a Guzzle exception if an error occurs.
* @throws ApiException Throws an API exception if an error occurs.
*/
public function creatingSubAccount(CreatingSubAccountRequest $request): CreatingSubAccountResponse {
Expand All @@ -162,7 +156,6 @@ public function creatingSubAccount(CreatingSubAccountRequest $request): Creating
* @param DeletingSmsRequest $request The deleting SMS request.
* @return DeletingSmsResponse Returns the delivery SMS message response.
* @throws InvalidArgumentException Throws an invalid argument exception if a parameter is missing.
* @throws GuzzleException Throws a Guzzle exception if an error occurs.
* @throws ApiException Throws an API exception if an error occurs.
*/
public function deletingSms(DeletingSmsRequest $request): DeletingSmsResponse {
Expand All @@ -180,7 +173,6 @@ public function deletingSms(DeletingSmsRequest $request): DeletingSmsResponse {
* @param DeletingSubAccountRequest $request The deleting sub-account request.
* @return DeletingSubAccountResponse Returns the delivery sub-account response.
* @throws InvalidArgumentException Throws an invalid argument exception if a parameter is missing.
* @throws GuzzleException Throws a Guzzle exception if an error occurs.
* @throws ApiException Throws an API exception if an error occurs.
*/
public function deletingSubAccount(DeletingSubAccountRequest $request): DeletingSubAccountResponse {
Expand All @@ -198,7 +190,6 @@ public function deletingSubAccount(DeletingSubAccountRequest $request): Deleting
* @param DeliveryReportRequest $request The delivery report request.
* @return DeliveryReportResponse Returns the delivery report response.
* @throws InvalidArgumentException Throws an invalid argument exception if a parameter is missing.
* @throws GuzzleException Throws a Guzzle exception if an error occurs.
* @throws ApiException Throws an API exception if an error occurs.
*/
public function deliveryReport(DeliveryReportRequest $request): DeliveryReportResponse {
Expand All @@ -216,7 +207,6 @@ public function deliveryReport(DeliveryReportRequest $request): DeliveryReportRe
* @param RetrievingSmsReplyRequest $request The retrieving SMS reply request.
* @return RetrievingSmsReplyResponse Returns the retrieving SMS reply response.
* @throws InvalidArgumentException Throws an invalid argument exception if a parameter is missing.
* @throws GuzzleException Throws a Guzzle exception if an error occurs.
* @throws ApiException Throws an API exception if an error occurs.
*/
public function retrievingSmsReply(RetrievingSmsReplyRequest $request): RetrievingSmsReplyResponse {
Expand All @@ -234,7 +224,6 @@ public function retrievingSmsReply(RetrievingSmsReplyRequest $request): Retrievi
* @param SendingSmsBatchRequest $request The sending SMS batch request.
* @return SendingSmsBatchResponse Returns the sending SMS message response.
* @throws InvalidArgumentException Throws an invalid argument exception if a parameter is missing.
* @throws GuzzleException Throws a Guzzle exception if an error occurs.
* @throws ApiException Throws an API exception if an error occurs.
*/
public function sendingSmsBatch(SendingSmsBatchRequest $request): SendingSmsBatchResponse {
Expand Down Expand Up @@ -263,7 +252,6 @@ public function sendingSmsBatch(SendingSmsBatchRequest $request): SendingSmsBatc
* @param SendingSmsMessageRequest $request The sending SMS message request.
* @return SendingSmsMessageResponse Returns the sending SMS message response.
* @throws InvalidArgumentException Throws an invalid argument exception if a parameter is missing.
* @throws GuzzleException Throws a Guzzle exception if an error occurs.
* @throws ApiException Throws an API exception if an error occurs.
*/
public function sendingSmsMessage(SendingSmsMessageRequest $request): SendingSmsMessageResponse {
Expand All @@ -287,7 +275,6 @@ public function sendingSmsMessage(SendingSmsMessageRequest $request): SendingSms
* @param SendingTextToSpeechSmsRequest $request The sending text-to-speech SMS request.
* @return SendingTextToSpeechSmsResponse Returns the sending text-to-speech response.
* @throws InvalidArgumentException Throws an invalid argument exception if a parameter is missing.
* @throws GuzzleException Throws a Guzzle exception if an error occurs.
* @throws ApiException Throws an API exception if an error occurs.
*/
public function sendingTextToSpeechSms(SendingTextToSpeechSmsRequest $request): SendingTextToSpeechSmsResponse {
Expand All @@ -311,7 +298,6 @@ public function sendingTextToSpeechSms(SendingTextToSpeechSmsRequest $request):
* @param SendingUnicodeSmsRequest $request The sending unicode SMS request.
* @return SendingUnicodeSmsResponse Returns the sending unicode response.
* @throws InvalidArgumentException Throws an invalid argument exception if a parameter is missing.
* @throws GuzzleException Throws a Guzzle exception if an error occurs.
* @throws ApiException Throws an API exception if an error occurs.
*/
public function sendingUnicodeSms(SendingUnicodeSmsRequest $request): SendingUnicodeSmsResponse {
Expand All @@ -335,7 +321,6 @@ public function sendingUnicodeSms(SendingUnicodeSmsRequest $request): SendingUni
* @param SentSmsMessageListRequest $request The sent SMS message list request.
* @return SentSmsMessageListResponse Returns the sent SMS message list response.
* @throws InvalidArgumentException Throws an invalid argument exception if a parameter is missing.
* @throws GuzzleException Throws a Guzzle exception if an error occurs.
* @throws ApiException Throws an API exception if an error occurs.
*/
public function sentSmsMessageList(SentSmsMessageListRequest $request): SentSmsMessageListResponse {
Expand All @@ -353,7 +338,6 @@ public function sentSmsMessageList(SentSmsMessageListRequest $request): SentSmsM
* @param TransferringCreditsRequest $request The transferring credits request.
* @return TransferringCreditsResponse Returns the transferring credits response.
* @throws InvalidArgumentException Throws an invalid argument exception if a parameter is missing.
* @throws GuzzleException Throws a Guzzle exception if an error occurs.
* @throws ApiException Throws an API exception if an error occurs.
*/
public function transferringCredits(TransferringCreditsRequest $request): TransferringCreditsResponse {
Expand Down

0 comments on commit 9893886

Please sign in to comment.