290 - Mark interfaces as api, refactoring interfaces

TwoFactorAuth/Api/AdminTokenServiceInterface.php

@@ -12,6 +12,7 @@
 
 /**
  * Obtain basic information about the user required to setup or use 2fa
+ * @api
  */
 interface AdminTokenServiceInterface extends OriginalTokenServiceInterface
 {

TwoFactorAuth/Api/AuthyAuthenticateInterface.php

@@ -10,6 +10,7 @@
 
 /**
  * Represents the authy provider authentication
+ * @api
  */
 interface AuthyAuthenticateInterface
 {

TwoFactorAuth/Api/AuthyConfigureInterface.php

@@ -13,6 +13,7 @@
 
 /**
  * Represents the authy provider
+ * @api
  */
 interface AuthyConfigureInterface
 {
@@ -21,7 +22,7 @@ interface AuthyConfigureInterface
      *
      * @param string $tfaToken
      * @param AuthyDeviceInterface $deviceData
-     * @return \Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseInterface
+     * @return ResponseInterface
      */
     public function sendDeviceRegistrationPrompt(
         string $tfaToken,

TwoFactorAuth/Api/CountryRepositoryInterface.php

@@ -14,7 +14,7 @@
 
 /**
  * Countries repository
- *
+ * @api
  * @SuppressWarnings(PHPMD.ShortVariable)
  */
 interface CountryRepositoryInterface

TwoFactorAuth/Api/Data/AdminTokenResponseInterface.php

@@ -9,9 +9,11 @@
 namespace Magento\TwoFactorAuth\Api\Data;
 
 use Magento\Framework\Api\ExtensibleDataInterface;
+use Magento\TwoFactorAuth\Api\ProviderInterface;
 
 /**
  * Represents the response to the new admin token response
+ * @api
  */
 interface AdminTokenResponseInterface extends ExtensibleDataInterface
 {
@@ -63,14 +65,14 @@ public function setMessage(string $value): void;
     /**
      * Get the providers
      *
-     * @return \Magento\TwoFactorAuth\Api\ProviderInterface[]
+     * @return ProviderInterface[]
      */
     public function getActiveProviders(): array;
 
     /**
      * Set the providers
      *
-     * @param \Magento\TwoFactorAuth\Api\ProviderInterface[] $value
+     * @param ProviderInterface[] $value
      * @return void
      */
     public function setActiveProviders(array $value): void;
@@ -80,14 +82,14 @@ public function setActiveProviders(array $value): void;
      *
      * Used fully qualified namespaces in annotations for proper work of extension interface/class code generation
      *
-     * @return \Magento\TwoFactorAuth\Api\Data\AdminTokenResponseExtensionInterface|null
+     * @return AdminTokenResponseExtensionInterface|null
      */
     public function getExtensionAttributes(): ?AdminTokenResponseExtensionInterface;
 
     /**
      * Set an extension attributes object
      *
-     * @param \Magento\TwoFactorAuth\Api\Data\AdminTokenResponseExtensionInterface $extensionAttributes
+     * @param AdminTokenResponseExtensionInterface $extensionAttributes
      * @return void
      */
     public function setExtensionAttributes(

TwoFactorAuth/Api/Data/AuthyDeviceInterface.php

@@ -11,6 +11,7 @@
 
 /**
  * Authy device data interface
+ * @api
  */
 interface AuthyDeviceInterface extends ExtensibleDataInterface
 {
@@ -89,14 +90,14 @@ public function setMethod(string $value): void;
      *
      * Used fully qualified namespaces in annotations for proper work of extension interface/class code generation
      *
-     * @return \Magento\TwoFactorAuth\Api\Data\AuthyDeviceExtensionInterface|null
+     * @return AuthyDeviceExtensionInterface|null
      */
     public function getExtensionAttributes(): ?AuthyDeviceExtensionInterface;
 
     /**
      * Set an extension attributes object
      *
-     * @param \Magento\TwoFactorAuth\Api\Data\AuthyDeviceExtensionInterface $extensionAttributes
+     * @param AuthyDeviceExtensionInterface $extensionAttributes
      * @return void
      */
     public function setExtensionAttributes(

TwoFactorAuth/Api/Data/AuthyRegistrationPromptResponseInterface.php

@@ -12,6 +12,7 @@
 
 /**
  * Response for device registration prompt
+ * @api
  */
 interface AuthyRegistrationPromptResponseInterface extends ExtensibleDataInterface
 {
@@ -60,14 +61,14 @@ public function setExpirationSeconds(int $value): void;
      *
      * Used fully qualified namespaces in annotations for proper work of extension interface/class code generation
      *
-     * @return \Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseExtensionInterface|null
+     * @return AuthyRegistrationPromptResponseExtensionInterface|null
      */
     public function getExtensionAttributes(): ?AuthyRegistrationPromptResponseExtensionInterface;
 
     /**
      * Set an extension attributes object
      *
-     * @param \Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseExtensionInterface $extensionAttributes
+     * @param AuthyRegistrationPromptResponseExtensionInterface $extensionAttributes
      * @return void
      */
     public function setExtensionAttributes(

TwoFactorAuth/Api/Data/CountryInterface.php

@@ -11,6 +11,7 @@
 
 /**
  * Country entity interface
+ * @api
  */
 interface CountryInterface extends ExtensibleDataInterface
 {
@@ -95,14 +96,14 @@ public function setDialCode(string $value): void;
      *
      * Used fully qualified namespaces in annotations for proper work of extension interface/class code generation
      *
-     * @return \Magento\TwoFactorAuth\Api\Data\CountryExtensionInterface|null
+     * @return CountryExtensionInterface|null
      */
     public function getExtensionAttributes(): ?CountryExtensionInterface;
 
     /**
      * Set an extension attributes object
      *
-     * @param \Magento\TwoFactorAuth\Api\Data\CountryExtensionInterface $extensionAttributes
+     * @param CountryExtensionInterface $extensionAttributes
      */
     public function setExtensionAttributes(
         CountryExtensionInterface $extensionAttributes

TwoFactorAuth/Api/Data/CountrySearchResultsInterface.php

@@ -11,6 +11,7 @@
 
 /**
  * Represent country search results
+ * @api
  */
 interface CountrySearchResultsInterface extends SearchResultsInterface
 {

TwoFactorAuth/Api/Data/DuoDataInterface.php

@@ -11,6 +11,7 @@
 
 /**
  * Represents the data needed to use duo
+ * @api
  */
 interface DuoDataInterface extends ExtensibleDataInterface
 {
@@ -59,14 +60,14 @@ public function setApiHostname(string $value): void;
      *
      * Used fully qualified namespaces in annotations for proper work of extension interface/class code generation
      *
-     * @return \Magento\TwoFactorAuth\Api\Data\DuoDataExtensionInterface|null
+     * @return DuoDataExtensionInterface|null
      */
     public function getExtensionAttributes(): ?DuoDataExtensionInterface;
 
     /**
      * Set an extension attributes object
      *
-     * @param \Magento\TwoFactorAuth\Api\Data\DuoDataExtensionInterface $extensionAttributes
+     * @param DuoDataExtensionInterface $extensionAttributes
      * @return void
      */
     public function setExtensionAttributes(

TwoFactorAuth/Api/Data/GoogleAuthenticateInterface.php

@@ -12,6 +12,7 @@
 
 /**
  * Represents the Google authentication data
+ * @api
  */
 interface GoogleAuthenticateInterface extends ExtensibleDataInterface
 {
@@ -37,14 +38,14 @@ public function setOtp(string $value): void;
      *
      * Used fully qualified namespaces in annotations for proper work of extension interface/class code generation
      *
-     * @return \Magento\TwoFactorAuth\Api\Data\GoogleAuthenticateExtensionInterface|null
+     * @return GoogleAuthenticateExtensionInterface|null
      */
     public function getExtensionAttributes(): ?GoogleAuthenticateExtensionInterface;
 
     /**
      * Set an extension attributes object
      *
-     * @param \Magento\TwoFactorAuth\Api\Data\GoogleAuthenticateExtensionInterface $extensionAttributes
+     * @param GoogleAuthenticateExtensionInterface $extensionAttributes
      */
     public function setExtensionAttributes(
         GoogleAuthenticateExtensionInterface $extensionAttributes

TwoFactorAuth/Api/Data/GoogleConfigureInterface.php

@@ -11,6 +11,7 @@
 
 /**
  * Google configuration data interface
+ * @api
  */
 interface GoogleConfigureInterface extends ExtensibleDataInterface
 {
@@ -59,14 +60,14 @@ public function setSecretCode(string $value): void;
      *
      * Used fully qualified namespaces in annotations for proper work of extension interface/class code generation
      *
-     * @return \Magento\TwoFactorAuth\Api\Data\GoogleConfigureExtensionInterface|null
+     * @return GoogleConfigureExtensionInterface|null
      */
     public function getExtensionAttributes(): ?GoogleConfigureExtensionInterface;
 
     /**
      * Set an extension attributes object
      *
-     * @param \Magento\TwoFactorAuth\Api\Data\GoogleConfigureExtensionInterface $extensionAttributes
+     * @param GoogleConfigureExtensionInterface $extensionAttributes
      * @return void
      */
     public function setExtensionAttributes(

TwoFactorAuth/Api/Data/U2fWebAuthnRequestInterface.php

@@ -12,6 +12,7 @@
 
 /**
  * Represents a WebAuthn dataset
+ * @api
  */
 interface U2fWebAuthnRequestInterface extends ExtensibleDataInterface
 {
@@ -37,14 +38,14 @@ public function setCredentialRequestOptionsJson(string $value): void;
      *
      * Used fully qualified namespaces in annotations for proper work of extension interface/class code generation
      *
-     * @return \Magento\TwoFactorAuth\Api\Data\U2fWebAuthnRequestExtensionInterface|null
+     * @return U2fWebAuthnRequestExtensionInterface|null
      */
     public function getExtensionAttributes(): ?U2fWebAuthnRequestExtensionInterface;
 
     /**
      * Set an extension attributes object
      *
-     * @param \Magento\TwoFactorAuth\Api\Data\U2fWebAuthnRequestExtensionInterface $extensionAttributes
+     * @param U2fWebAuthnRequestExtensionInterface $extensionAttributes
      * @return void
      */
     public function setExtensionAttributes(

TwoFactorAuth/Api/Data/UserConfigInterface.php

@@ -11,6 +11,7 @@
 
 /**
  * User configuration interface
+ * @api
  */
 interface UserConfigInterface extends ExtensibleDataInterface
 {
@@ -95,14 +96,14 @@ public function setDefaultProvider(string $value): void;
      *
      * Used fully qualified namespaces in annotations for proper work of extension interface/class code generation
      *
-     * @return \Magento\TwoFactorAuth\Api\Data\UserConfigExtensionInterface|null
+     * @return UserConfigExtensionInterface|null
      */
     public function getExtensionAttributes(): ?UserConfigExtensionInterface;
 
     /**
      * Set an extension attributes object
      *
-     * @param \Magento\TwoFactorAuth\Api\Data\UserConfigExtensionInterface $extensionAttributes
+     * @param UserConfigExtensionInterface $extensionAttributes
      */
     public function setExtensionAttributes(UserConfigExtensionInterface $extensionAttributes): void;
 }

TwoFactorAuth/Api/Data/UserConfigSearchResultsInterface.php

@@ -11,6 +11,7 @@
 
 /**
  * User config search result
+ * @api
  */
 interface UserConfigSearchResultsInterface extends SearchResultsInterface
 {

TwoFactorAuth/Api/DuoAuthenticateInterface.php

@@ -12,6 +12,7 @@
 
 /**
  * Represents authentication for the duo security provider
+ * @api
  */
 interface DuoAuthenticateInterface
 {
@@ -20,7 +21,7 @@ interface DuoAuthenticateInterface
      *
      * @param string $username
      * @param string $password
-     * @return \Magento\TwoFactorAuth\Api\Data\DuoDataInterface
+     * @return DuoDataInterface
      */
     public function getAuthenticateData(
         string $username,

TwoFactorAuth/Api/DuoConfigureInterface.php

@@ -12,14 +12,15 @@
 
 /**
  * Represents configuration for the duo security provider
+ * @api
  */
 interface DuoConfigureInterface
 {
     /**
      * Get the information required to configure duo
      *
      * @param string $tfaToken
-     * @return \Magento\TwoFactorAuth\Api\Data\DuoDataInterface
+     * @return DuoDataInterface
      */
     public function getConfigurationData(
         string $tfaToken

TwoFactorAuth/Api/EngineInterface.php

@@ -12,6 +12,7 @@
 
 /**
  * 2FA engine interface
+ * @api
  */
 interface EngineInterface
 {

TwoFactorAuth/Api/Exception/NotificationExceptionInterface.php

@@ -10,6 +10,7 @@
 
 /**
  * Occurs when failed to notify a user.
+ * @api
  */
 interface NotificationExceptionInterface extends \Throwable
 {

TwoFactorAuth/Api/GoogleAuthenticateInterface.php

@@ -10,6 +10,7 @@
 
 /**
  * Represents google authentication
+ * @api
  */
 interface GoogleAuthenticateInterface
 {

TwoFactorAuth/Api/GoogleConfigureInterface.php

@@ -10,18 +10,19 @@
 
 /**
  * Represents the google provider
+ * @api
  */
 interface GoogleConfigureInterface
 {
     /**
      * Get the information required to configure google
      *
      * @param string $tfaToken
-     * @return \Magento\TwoFactorAuth\Api\Data\GoogleConfigureInterface
+     * @return Data\GoogleConfigureInterface
      */
     public function getConfigurationData(
         string $tfaToken
-    ): \Magento\TwoFactorAuth\Api\Data\GoogleConfigureInterface;
+    ): Data\GoogleConfigureInterface;
 
     /**
      * Activate the provider and get an admin token