create DTO for user expiration (#19093)

Author: lfolco

app/code/Magento/Security/Api/Data/UserExpirationInterface.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\Security\Api\Data;
+
+/**
+ * Interface UserExpirationInterface to be used as a DTO for expires_at property on User model.
+ */
+interface UserExpirationInterface
+{
+
+    const EXPIRES_AT = 'expires_at';
+
+    const USER_ID = 'user_id';
+
+    /**
+     * `expires_at` getter.
+     *
+     * @return string
+     */
+    public function getExpiresAt();
+
+    /**
+     * `expires_at` setter.
+     *
+     * @param string $expiresAt
+     * @return $this
+     */
+    public function setExpiresAt($expiresAt);
+
+    /**
+     * `user_id` getter.
+     *
+     * @return string
+     */
+    public function getUserId();
+
+    /**
+     * `user_id` setter.
+     *
+     * @param string $userId
+     * @return $this
+     */
+    public function setUserId($userId);
+}

app/code/Magento/Security/Model/UserExpiration.php

@@ -7,14 +7,12 @@
 
 namespace Magento\Security\Model;
 
+use Magento\Security\Api\Data\UserExpirationInterface;
+
 /**
  * Admin User Expiration model.
- * @method string getUserId()
- * @method \Magento\Security\Model\UserExpiration setUserId($userId)
- * @method string getExpiresAt()
- * @method \Magento\Security\Model\UserExpiration setExpiresAt($value)
  */
-class UserExpiration extends \Magento\Framework\Model\AbstractModel
+class UserExpiration extends \Magento\Framework\Model\AbstractModel implements UserExpirationInterface
 {
 
     /**
@@ -26,4 +24,46 @@ protected function _construct()
     {
         $this->_init(\Magento\Security\Model\ResourceModel\UserExpiration::class);
     }
+
+    /**
+     * `expires_at` getter.
+     *
+     * @return string
+     */
+    public function getExpiresAt()
+    {
+        return $this->getData(self::EXPIRES_AT);
+    }
+
+    /**
+     * `expires_at` setter.
+     *
+     * @param string $expiresAt
+     * @return $this
+     */
+    public function setExpiresAt($expiresAt)
+    {
+        return $this->setData(self::EXPIRES_AT, $expiresAt);
+    }
+
+    /**
+     * `user_id` getter.
+     *
+     * @return string
+     */
+    public function getUserId()
+    {
+        return $this->getData(self::USER_ID);
+    }
+
+    /**
+     * `user_id` setter.
+     *
+     * @param string $userId
+     * @return $this
+     */
+    public function setUserId($userId)
+    {
+        return $this->setData(self::USER_ID, $userId);
+    }
 }

app/code/Magento/Security/etc/di.xml

@@ -18,4 +18,5 @@
             </argument>
         </arguments>
     </type>
+    <preference for="Magento\Security\Api\Data\UserExpirationInterface" type="Magento\Security\Model\UserExpiration"/>
 </config>