diff --git a/src/Api/EmailValidationV4.php b/src/Api/EmailValidationV4.php index 64fba92..e2263a4 100644 --- a/src/Api/EmailValidationV4.php +++ b/src/Api/EmailValidationV4.php @@ -34,8 +34,9 @@ class EmailValidationV4 extends HttpApi * Addresses are validated based off defined checks. * * @param string $address An email address to validate. Maximum: 512 characters. - * @param bool $providerLookup + * * @return ValidateResponse|ResponseInterface + * * @throws Exception Thrown when we don't catch a Client or Server side Exception */ public function validate(string $address, bool $providerLookup = true) @@ -53,9 +54,10 @@ class EmailValidationV4 extends HttpApi } /** - * @param string $listId - * @param $filePath - file path or file content + * @param mixed $filePath - file path or file content + * * @return mixed|ResponseInterface + * * @throws Exception */ public function createBulkJob(string $listId, $filePath) @@ -81,10 +83,7 @@ class EmailValidationV4 extends HttpApi } /** - * @param string $fieldName * @param array $filePath ['fileContent' => 'content'] or ['filePath' => '/foo/bar'] - * - * @return array */ private function prepareFile(string $fieldName, array $filePath): array { @@ -118,7 +117,6 @@ class EmailValidationV4 extends HttpApi /** * Close open resources. - * @param array $params */ private function closeResources(array $params): void { @@ -130,8 +128,8 @@ class EmailValidationV4 extends HttpApi } /** - * @param string $listId * @return DeleteBulkJobResponse|ResponseInterface + * * @throws Exception */ public function deleteBulkJob(string $listId) @@ -144,8 +142,8 @@ class EmailValidationV4 extends HttpApi } /** - * @param string $listId * @return GetBulkJobResponse|ResponseInterface + * * @throws Exception */ public function getBulkJob(string $listId) @@ -158,8 +156,8 @@ class EmailValidationV4 extends HttpApi } /** - * @param int $limit * @return GetBulkJobsResponse|ResponseInterface + * * @throws Exception */ public function getBulkJobs(int $limit = 500) @@ -187,9 +185,8 @@ class EmailValidationV4 extends HttpApi } /** - * @param string $previewId - * @param $filePath * @return mixed|ResponseInterface + * * @throws Exception */ public function createBulkPreview(string $previewId, $filePath) @@ -215,8 +212,8 @@ class EmailValidationV4 extends HttpApi } /** - * @param string $previewId * @return mixed|ResponseInterface + * * @throws Exception */ public function getBulkPreview(string $previewId) @@ -229,7 +226,6 @@ class EmailValidationV4 extends HttpApi } /** - * @param string $previewId * @return bool */ public function deleteBulkPreview(string $previewId) @@ -238,12 +234,12 @@ class EmailValidationV4 extends HttpApi $response = $this->httpDelete(sprintf('/v4/address/validate/preview/%s', $previewId)); - return $response->getStatusCode() === 204; + return 204 === $response->getStatusCode(); } /** - * @param string $previewId * @return mixed|ResponseInterface + * * @throws Exception */ public function promoteBulkPreview(string $previewId) diff --git a/src/Model/EmailValidationV4/CreateBulkJobResponse.php b/src/Model/EmailValidationV4/CreateBulkJobResponse.php index 75bf7d6..c94a927 100644 --- a/src/Model/EmailValidationV4/CreateBulkJobResponse.php +++ b/src/Model/EmailValidationV4/CreateBulkJobResponse.php @@ -39,17 +39,11 @@ final class CreateBulkJobResponse implements ApiResponse return $model; } - /** - * @return string|null - */ public function getId(): ?string { return $this->id; } - /** - * @return string|null - */ public function getMessage(): ?string { return $this->message; diff --git a/src/Model/EmailValidationV4/CreateBulkPreviewResponse.php b/src/Model/EmailValidationV4/CreateBulkPreviewResponse.php index 264f3a4..f4db70d 100644 --- a/src/Model/EmailValidationV4/CreateBulkPreviewResponse.php +++ b/src/Model/EmailValidationV4/CreateBulkPreviewResponse.php @@ -39,17 +39,11 @@ final class CreateBulkPreviewResponse implements ApiResponse return $model; } - /** - * @return string|null - */ public function getId(): ?string { return $this->id; } - /** - * @return string|null - */ public function getMessage(): ?string { return $this->message; diff --git a/src/Model/EmailValidationV4/DeleteBulkJobResponse.php b/src/Model/EmailValidationV4/DeleteBulkJobResponse.php index 1e12c6e..e698d65 100644 --- a/src/Model/EmailValidationV4/DeleteBulkJobResponse.php +++ b/src/Model/EmailValidationV4/DeleteBulkJobResponse.php @@ -33,9 +33,6 @@ final class DeleteBulkJobResponse implements ApiResponse return $model; } - /** - * @return string|null - */ public function getMessage(): ?string { return $this->message; diff --git a/src/Model/EmailValidationV4/GetBulkJobsResponse.php b/src/Model/EmailValidationV4/GetBulkJobsResponse.php index 3c6d9a4..a36df85 100644 --- a/src/Model/EmailValidationV4/GetBulkJobsResponse.php +++ b/src/Model/EmailValidationV4/GetBulkJobsResponse.php @@ -51,17 +51,11 @@ final class GetBulkJobsResponse implements ApiResponse return $model; } - /** - * @return int - */ public function getTotal(): int { return $this->total; } - /** - * @return array - */ public function getJobs(): array { return $this->jobs; diff --git a/src/Model/EmailValidationV4/GetBulkPreviewResponse.php b/src/Model/EmailValidationV4/GetBulkPreviewResponse.php index 1e3a14f..4961d97 100644 --- a/src/Model/EmailValidationV4/GetBulkPreviewResponse.php +++ b/src/Model/EmailValidationV4/GetBulkPreviewResponse.php @@ -18,7 +18,7 @@ final class GetBulkPreviewResponse implements ApiResponse /** * @var Preview */ - private $preview = []; + private $preview; private function __construct() { @@ -32,9 +32,6 @@ final class GetBulkPreviewResponse implements ApiResponse return $model; } - /** - * @return Preview - */ public function getPreview(): Preview { return $this->preview; diff --git a/src/Model/EmailValidationV4/GetBulkPreviewsResponse.php b/src/Model/EmailValidationV4/GetBulkPreviewsResponse.php index 94ed581..af3a624 100644 --- a/src/Model/EmailValidationV4/GetBulkPreviewsResponse.php +++ b/src/Model/EmailValidationV4/GetBulkPreviewsResponse.php @@ -41,9 +41,6 @@ final class GetBulkPreviewsResponse implements ApiResponse return $model; } - /** - * @return array - */ public function getPreviews(): array { return $this->previews; diff --git a/src/Model/EmailValidationV4/Job.php b/src/Model/EmailValidationV4/Job.php index 42d54e2..a2dc4c2 100644 --- a/src/Model/EmailValidationV4/Job.php +++ b/src/Model/EmailValidationV4/Job.php @@ -51,7 +51,7 @@ class Job implements ApiResponse */ private $summary; - private function __construct() + final private function __construct() { } @@ -70,57 +70,36 @@ class Job implements ApiResponse return $model; } - /** - * @return DateTimeImmutable|null - */ public function getCreatedAt(): ?DateTimeImmutable { return $this->createdAt; } - /** - * @return JobDownloadUrl - */ public function getDownloadUrl(): JobDownloadUrl { return $this->downloadUrl; } - /** - * @return string|null - */ public function getId(): ?string { return $this->id; } - /** - * @return int - */ public function getQuantity(): int { return $this->quantity; } - /** - * @return int - */ public function getRecordsProcessed(): int { return $this->recordsProcessed; } - /** - * @return string|null - */ public function getStatus(): ?string { return $this->status; } - /** - * @return mixed - */ public function getSummary(): Summary { return $this->summary; diff --git a/src/Model/EmailValidationV4/Preview.php b/src/Model/EmailValidationV4/Preview.php index 0f5469b..02fb74f 100644 --- a/src/Model/EmailValidationV4/Preview.php +++ b/src/Model/EmailValidationV4/Preview.php @@ -46,7 +46,7 @@ class Preview implements ApiResponse */ private $summary; - private function __construct() + final private function __construct() { } @@ -58,55 +58,37 @@ class Preview implements ApiResponse $model->valid = $data['valid'] ?? null; $model->status = $data['status'] ?? null; $model->quantity = $data['quantity'] ?? null; - $model->createdAt = isset($data['created_at']) ? DateTimeImmutable::createFromFormat('U', (string)($data['created_at'])) : null; + $model->createdAt = isset($data['created_at']) ? DateTimeImmutable::createFromFormat('U', (string) ($data['created_at'])) : null; $model->summary = Summary::create($data['summary']); return $model; } - /** - * @return string|null - */ public function getId(): ?string { return $this->id; } - /** - * @return bool|null - */ public function isValid(): ?bool { return $this->valid; } - /** - * @return int - */ public function getQuantity(): int { return $this->quantity; } - /** - * @return string|null - */ public function getStatus(): ?string { return $this->status; } - /** - * @return DateTimeImmutable|null - */ public function getCreatedAt(): ?DateTimeImmutable { return $this->createdAt; } - /** - * @return mixed - */ public function getSummary(): Summary { return $this->summary; diff --git a/src/Model/EmailValidationV4/PromoteBulkPreviewResponse.php b/src/Model/EmailValidationV4/PromoteBulkPreviewResponse.php index 2933d99..58a311e 100644 --- a/src/Model/EmailValidationV4/PromoteBulkPreviewResponse.php +++ b/src/Model/EmailValidationV4/PromoteBulkPreviewResponse.php @@ -33,9 +33,6 @@ final class PromoteBulkPreviewResponse implements ApiResponse return $model; } - /** - * @return string|null - */ public function getMessage(): ?string { return $this->message; diff --git a/src/Model/EmailValidationV4/Summary.php b/src/Model/EmailValidationV4/Summary.php index 3a58700..6ffe6c8 100644 --- a/src/Model/EmailValidationV4/Summary.php +++ b/src/Model/EmailValidationV4/Summary.php @@ -39,17 +39,11 @@ final class Summary implements ApiResponse { } - /** - * @return SummaryResult - */ public function getResult(): SummaryResult { return $this->result; } - /** - * @return SummaryRisk - */ public function getRisk(): SummaryRisk { return $this->risk; diff --git a/src/Model/EmailValidationV4/SummaryResult.php b/src/Model/EmailValidationV4/SummaryResult.php index 528855f..6de9332 100644 --- a/src/Model/EmailValidationV4/SummaryResult.php +++ b/src/Model/EmailValidationV4/SummaryResult.php @@ -56,41 +56,26 @@ final class SummaryResult implements ApiResponse { } - /** - * @return int - */ public function getDeliverable(): int { return $this->deliverable; } - /** - * @return int - */ public function getDoNotSend(): int { return $this->doNotSend; } - /** - * @return int - */ public function getUndeliverable(): int { return $this->undeliverable; } - /** - * @return int - */ public function getCatchAll(): int { return $this->catchAll; } - /** - * @return int - */ public function getUnknown(): int { return $this->unknown; diff --git a/src/Model/EmailValidationV4/SummaryRisk.php b/src/Model/EmailValidationV4/SummaryRisk.php index c373e7b..01cb4a8 100644 --- a/src/Model/EmailValidationV4/SummaryRisk.php +++ b/src/Model/EmailValidationV4/SummaryRisk.php @@ -51,33 +51,21 @@ final class SummaryRisk implements ApiResponse { } - /** - * @return int - */ public function getHigh(): int { return $this->high; } - /** - * @return int - */ public function getLow(): int { return $this->low; } - /** - * @return int - */ public function getMedium(): int { return $this->medium; } - /** - * @return int - */ public function getUnknown(): int { return $this->unknown; diff --git a/src/Model/EmailValidationV4/ValidateResponse.php b/src/Model/EmailValidationV4/ValidateResponse.php index 70023d4..3ad6fbf 100644 --- a/src/Model/EmailValidationV4/ValidateResponse.php +++ b/src/Model/EmailValidationV4/ValidateResponse.php @@ -74,65 +74,41 @@ final class ValidateResponse implements ApiResponse return $model; } - /** - * @return string|null - */ public function getAddress(): ?string { return $this->address; } - /** - * @return string|null - */ public function getDidYouMean(): ?string { return $this->didYouMean; } - /** - * @return bool - */ public function isDisposableAddress(): bool { return $this->isDisposableAddress; } - /** - * @return bool - */ public function isRoleAddress(): bool { return $this->isRoleAddress; } - /** - * @return array - */ public function getReason(): array { return $this->reason; } - /** - * @return string|null - */ public function getResult(): ?string { return $this->result; } - /** - * @return string|null - */ public function getRisk(): ?string { return $this->risk; } - /** - * @return string|null - */ public function getRootAddress(): ?string { return $this->rootAddress; diff --git a/tests/Model/EmailValidationV4/JobDownloadUrlTest.php b/tests/Model/EmailValidationV4/JobDownloadUrlTest.php index e436c58..3d7f2dd 100644 --- a/tests/Model/EmailValidationV4/JobDownloadUrlTest.php +++ b/tests/Model/EmailValidationV4/JobDownloadUrlTest.php @@ -11,9 +11,7 @@ declare(strict_types=1); namespace Mailgun\Tests\Model\Event; -use Mailgun\Model\EmailValidationV4\Job; use Mailgun\Model\EmailValidationV4\JobDownloadUrl; -use Mailgun\Model\EmailValidationV4\Summary; use Mailgun\Tests\Model\BaseModelTest; class JobDownloadUrlTest extends BaseModelTest diff --git a/tests/Model/EmailValidationV4/PreviewTest.php b/tests/Model/EmailValidationV4/PreviewTest.php index 2adf2ff..1ef02b4 100644 --- a/tests/Model/EmailValidationV4/PreviewTest.php +++ b/tests/Model/EmailValidationV4/PreviewTest.php @@ -11,8 +11,6 @@ declare(strict_types=1); namespace Mailgun\Tests\Model\Event; -use Mailgun\Model\EmailValidationV4\Job; -use Mailgun\Model\EmailValidationV4\JobDownloadUrl; use Mailgun\Model\EmailValidationV4\Preview; use Mailgun\Model\EmailValidationV4\Summary; use Mailgun\Tests\Model\BaseModelTest; diff --git a/tests/Model/EmailValidationV4/SummaryResultTest.php b/tests/Model/EmailValidationV4/SummaryResultTest.php index 18d2008..5163481 100644 --- a/tests/Model/EmailValidationV4/SummaryResultTest.php +++ b/tests/Model/EmailValidationV4/SummaryResultTest.php @@ -11,11 +11,7 @@ declare(strict_types=1); namespace Mailgun\Tests\Model\Event; -use Mailgun\Model\EmailValidationV4\Job; -use Mailgun\Model\EmailValidationV4\JobDownloadUrl; -use Mailgun\Model\EmailValidationV4\Summary; use Mailgun\Model\EmailValidationV4\SummaryResult; -use Mailgun\Model\EmailValidationV4\SummaryRisk; use Mailgun\Tests\Model\BaseModelTest; class SummaryResultTest extends BaseModelTest diff --git a/tests/Model/EmailValidationV4/SummaryRiskTest.php b/tests/Model/EmailValidationV4/SummaryRiskTest.php index ae7bf40..dd834f1 100644 --- a/tests/Model/EmailValidationV4/SummaryRiskTest.php +++ b/tests/Model/EmailValidationV4/SummaryRiskTest.php @@ -11,10 +11,6 @@ declare(strict_types=1); namespace Mailgun\Tests\Model\Event; -use Mailgun\Model\EmailValidationV4\Job; -use Mailgun\Model\EmailValidationV4\JobDownloadUrl; -use Mailgun\Model\EmailValidationV4\Summary; -use Mailgun\Model\EmailValidationV4\SummaryResult; use Mailgun\Model\EmailValidationV4\SummaryRisk; use Mailgun\Tests\Model\BaseModelTest; diff --git a/tests/Model/EmailValidationV4/SummaryTest.php b/tests/Model/EmailValidationV4/SummaryTest.php index 18d48ee..50369c0 100644 --- a/tests/Model/EmailValidationV4/SummaryTest.php +++ b/tests/Model/EmailValidationV4/SummaryTest.php @@ -11,8 +11,6 @@ declare(strict_types=1); namespace Mailgun\Tests\Model\Event; -use Mailgun\Model\EmailValidationV4\Job; -use Mailgun\Model\EmailValidationV4\JobDownloadUrl; use Mailgun\Model\EmailValidationV4\Summary; use Mailgun\Model\EmailValidationV4\SummaryResult; use Mailgun\Model\EmailValidationV4\SummaryRisk;