return string instead of CouponInterface (#761)

Co-authored-by: Carter Buce <[email protected]>

Author: carterbuce

app/code/Meta/Sales/Api/NewsletterSubscriptionDiscountApiInterface.php

@@ -17,9 +17,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-namespace Meta\Sales\Api;
 
-use Magento\SalesRule\Api\Data\CouponInterface;
+namespace Meta\Sales\Api;
 
 interface NewsletterSubscriptionDiscountApiInterface
 {
@@ -28,10 +27,10 @@ interface NewsletterSubscriptionDiscountApiInterface
      *
      * If valid, returns an opt-in coupon.
      *
-     * @param  string $externalBusinessId
-     * @param  string $email
-     * @param  int    $ruleId
-     * @return \Magento\SalesRule\Api\Data\CouponInterface
+     * @param string $externalBusinessId
+     * @param string $email
+     * @param int $ruleId
+     * @return string
      */
-    public function subscribeForCoupon(string $externalBusinessId, string $email, int $ruleId): CouponInterface;
+    public function subscribeForCoupon(string $externalBusinessId, string $email, int $ruleId): string;
 }

app/code/Meta/Sales/Model/Api/NewsletterSubscriptionDiscountApi.php

@@ -21,7 +21,6 @@
 namespace Meta\Sales\Model\Api;
 
 use Magento\Newsletter\Model\SubscriberFactory;
-use Magento\SalesRule\Api\Data\CouponInterface;
 use Magento\SalesRule\Model\RuleFactory;
 use Magento\SalesRule\Model\Coupon\MassgeneratorFactory;
 use Meta\BusinessExtension\Helper\FBEHelper;
@@ -106,10 +105,10 @@ public function __construct(
      * @param string $externalBusinessId The external business ID.
      * @param string $email The email address of the subscriber.
      * @param int $ruleId The ID of the sales rule.
-     * @return CouponInterface The generated coupon.
+     * @return string The generated coupon.
      * @throws LocalizedException If an error occurs during the process.
      */
-    public function subscribeForCoupon(string $externalBusinessId, string $email, int $ruleId): CouponInterface
+    public function subscribeForCoupon(string $externalBusinessId, string $email, int $ruleId): string
     {
         $this->authenticator->authenticateRequest();
 
@@ -128,14 +127,16 @@ public function subscribeForCoupon(string $externalBusinessId, string $email, in
                 throw new LocalizedException(__('The specified discount rule does not exist.'));
             }
 
+            $coupon = $this->generateCoupon((int)$rule->getId());
+
             // Subscribe the user to the newsletter
             $subscriber = $this->subscriberFactory->create();
             $subscriber->setStoreId($storeId);
             $subscriber->setSubscriberEmail($email);
             $subscriber->setSubscriberStatus(\Magento\Newsletter\Model\Subscriber::STATUS_SUBSCRIBED);
             $subscriber->save();
 
-            return $this->generateCoupon((int)$rule->getId());
+            return $coupon;
         } catch (\Exception $e) {
             $this->fbeHelper->logExceptionImmediatelyToMeta(
                 $e,
@@ -160,7 +161,7 @@ public function subscribeForCoupon(string $externalBusinessId, string $email, in
      * @param int $ruleId The sales rule ID.
      * @return string The generated coupon code.
      */
-    private function generateCoupon(int $ruleId): CouponInterface
+    private function generateCoupon(int $ruleId): string
     {
         $rule = $this->ruleFactory->create()->load($ruleId);
         if (!$rule->getId()) {