Remove not used import and update docblocks with relevant throws

upmind-automation · May 13, 2024 · 1a97a69 · 1a97a69
1 parent 2ccddb9
commit 1a97a69
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 6 deletions.
diff --git a/src/Data/CreateResult.php b/src/Data/CreateResult.php
@@ -4,7 +4,6 @@
 
 namespace Upmind\ProvisionProviders\Seo\Data;
 
-use Upmind\ProvisionBase\Provider\DataSet\DataSet;
 use Upmind\ProvisionBase\Provider\DataSet\ResultData;
 use Upmind\ProvisionBase\Provider\DataSet\Rules;
 

diff --git a/src/Data/LoginResult.php b/src/Data/LoginResult.php
@@ -4,7 +4,6 @@
 
 namespace Upmind\ProvisionProviders\Seo\Data;
 
-use Upmind\ProvisionBase\Provider\DataSet\DataSet;
 use Upmind\ProvisionBase\Provider\DataSet\ResultData;
 use Upmind\ProvisionBase\Provider\DataSet\Rules;
 

diff --git a/src/Providers/Example/Provider.php b/src/Providers/Example/Provider.php
@@ -22,7 +22,7 @@
 class Provider extends Category implements ProviderInterface
 {
     protected Configuration $configuration;
-    protected Client $client;
+    protected Client|null $client = null;
 
     public function __construct(Configuration $configuration)
     {
@@ -42,18 +42,22 @@ public static function aboutProvider(): AboutData
 
     /**
      * @inheritDoc
+     *
+     * @throws \Upmind\ProvisionBase\Exception\ProvisionFunctionError
      */
     public function create(CreateParams $params): CreateResult
     {
-        throw $this->errorResult('Not Implemented');
+        $this->errorResult('Not Implemented');
     }
 
     /**
      * @inheritDoc
+     *
+     * @throws \Upmind\ProvisionBase\Exception\ProvisionFunctionError
      */
     public function changePackage(ChangePackageParams $params): EmptyResult
     {
-        throw $this->errorResult('Not Implemented');
+        $this->errorResult('Not Implemented');
     }
 
     /**

diff --git a/src/Providers/Marketgoo/Exceptions/OperationFailed.php b/src/Providers/Marketgoo/Exceptions/OperationFailed.php
@@ -4,7 +4,6 @@
 
 namespace Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions;
 
-use Throwable;
 use Upmind\ProvisionBase\Exception\ProvisionFunctionError;
 
 /**

diff --git a/src/Providers/Marketgoo/Provider.php b/src/Providers/Marketgoo/Provider.php
@@ -42,6 +42,10 @@ public function __construct(Configuration $configuration)
         $this->configuration = $configuration;
     }
 
+    /**
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed
+     */
     public function create(CreateParams $params): CreateResult
     {
         $domainName = $params->domain;
@@ -61,11 +65,19 @@ public function create(CreateParams $params): CreateResult
             ->setMessage('Account created');
     }
 
+    /**
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed
+     */
     public function login(AccountIdentifierParams $params): LoginResult
     {
         return LoginResult::create()->setUrl($this->getLoginUrl($params->username));
     }
 
+    /**
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed
+     */
     public function changePackage(ChangePackageParams $params): EmptyResult
     {
         try {
@@ -81,6 +93,10 @@ public function changePackage(ChangePackageParams $params): EmptyResult
         return EmptyResult::create()->setMessage('Account updated');
     }
 
+    /**
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed
+     */
     public function suspend(AccountIdentifierParams $params): EmptyResult
     {
         try {
@@ -96,6 +112,10 @@ public function suspend(AccountIdentifierParams $params): EmptyResult
         return EmptyResult::create()->setMessage('Account suspended');
     }
 
+    /**
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed
+     */
     public function unsuspend(AccountIdentifierParams $params): EmptyResult
     {
         try {
@@ -111,6 +131,10 @@ public function unsuspend(AccountIdentifierParams $params): EmptyResult
         return EmptyResult::create()->setMessage('Account unsuspended');
     }
 
+    /**
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed
+     */
     public function terminate(AccountIdentifierParams $params): EmptyResult
     {
         $this->deleteAccount($params->username);
@@ -133,6 +157,10 @@ protected function client(): Client
         ]);
     }
 
+    /**
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed
+     */
     protected function getLoginUrl(string $username): string
     {
         // get 5-minute ttl sso link
@@ -141,6 +169,10 @@ protected function getLoginUrl(string $username): string
         return $handler->getLoginUrl();
     }
 
+    /**
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed
+     */
     private function createAccount(
         string $domainName,
         string $productKey,
@@ -167,6 +199,10 @@ private function createAccount(
         return $handler->getAccountIdentifier('create');
     }
 
+    /**
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed
+     */
     private function upgradeAccount(string $accountId, string $productKey): void
     {
         $response = $this->client()->patch("accounts/{$accountId}/upgrade", [
@@ -185,20 +221,32 @@ private function upgradeAccount(string $accountId, string $productKey): void
         $handler->assertSuccess('upgrade');
     }
 
+    /**
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed
+     */
     private function suspendAccount(string $accountId): void
     {
         $response = $this->client()->patch("accounts/{$accountId}/suspend");
         $handler = new ResponseHandler($response);
         $handler->assertSuccess('suspend');
     }
 
+    /**
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed
+     */
     private function resumeAccount(string $accountId): void
     {
         $response = $this->client()->patch("accounts/{$accountId}/resume");
         $handler = new ResponseHandler($response);
         $handler->assertSuccess('resume');
     }
 
+    /**
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Upmind\ProvisionProviders\Seo\Providers\Marketgoo\Exceptions\OperationFailed
+     */
     private function deleteAccount(string $accountId): void
     {
         $response = $this->client()->delete("accounts/{$accountId}");