initial commit: Interfaces and apis to support email opt-in (#679)

* initial commit: Interfaces and apis to support email opt-in

* Tweaking interfaces, adding implementation for EmailSubscription endpoint

* Removing PriceAdjustment logic for a later commit

* Initial commit: Declarative apis for discount rule creation

* fixing di.xml settings

* confirmed working check subscription endpoint

* Confirmed working all APIs

* Fixing nits from review

* adding back authentication

Author: sol-loup

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

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+namespace Meta\Sales\Api;
+
+interface DiscountDeleteApiInterface
+{
+    /**
+     * Delete expired/used coupon codes
+     *
+     * @param string $externalBusinessId
+     * @param string[] $couponIds
+     * @return string[]
+     */
+    public function deleteDiscount(string $externalBusinessId, array $couponIds): array;
+}

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

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+namespace Meta\Sales\Api;
+
+use Magento\SalesRule\Api\Data\RuleInterface;
+
+interface DiscountRuleApiInterface
+{
+    /**
+     * Create a cart rule
+     *
+     * @param string $externalBusinessId
+     * @param RuleInterface $rule
+     * @return string
+     */
+    public function createRule(string $externalBusinessId, RuleInterface $rule): string;
+}

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

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+namespace Meta\Sales\Api;
+
+use Magento\SalesRule\Api\Data\CouponInterface;
+
+interface NewsletterSubscriptionDiscountApiInterface
+{
+    /**
+     * Add an email to the newsletter subscription list
+     *
+     * If valid, returns an opt-in coupon.
+     *
+     * @param string $externalBusinessId
+     * @param string $email
+     * @param int $ruleId
+     * @return CouponInterface
+     */
+    public function subscribeForCoupon(string $externalBusinessId, string $email, int $ruleId): CouponInterface;
+}

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

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+namespace Meta\Sales\Api;
+
+interface NewsletterSubscriptionDiscountStatusApiInterface
+{
+    /**
+     * Add an email to the newsletter subscription list
+     *
+     * / Split existence check into a separate API
+     *
+     * @param string $externalBusinessId
+     * @param string $email
+     * @return bool
+     */
+    public function checkSubscriptionStatus(string $externalBusinessId, string $email): bool;
+}

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

@@ -0,0 +1,84 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Meta\Sales\Model\Api;
+
+use Magento\Framework\App\ResourceConnection;
+use Magento\Framework\Exception\LocalizedException;
+use Meta\BusinessExtension\Model\Api\CustomApiKey\Authenticator;
+
+class DiscountDeleteApi implements \Meta\Sales\Api\DiscountDeleteApiInterface
+{
+    /**
+     * @var ResourceConnection
+     */
+    private ResourceConnection $resourceConnection;
+
+    /**
+     * @var Authenticator
+     */
+    private Authenticator $authenticator;
+
+    /**
+     * DiscountDeleteApi constructor.
+     *
+     * @param ResourceConnection $resourceConnection
+     * @param Authenticator $authenticator
+     */
+    public function __construct(ResourceConnection $resourceConnection, Authenticator $authenticator)
+    {
+        $this->resourceConnection = $resourceConnection;
+        $this->authenticator = $authenticator;
+    }
+
+    /**
+     * Delete expired/used coupon codes
+     *
+     * @param string $externalBusinessId
+     * @param string[] $couponCodes
+     * @return string[]
+     * @throws LocalizedException
+     */
+    public function deleteDiscount(string $externalBusinessId, array $couponCodes): array
+    {
+        $this->authenticator->authenticateRequest();
+
+        try {
+            $connection = $this->resourceConnection->getConnection();
+            $couponTable = $this->resourceConnection->getTableName('salesrule_coupon');
+
+            $deletedCouponCodes = [];
+
+            if (!empty($couponCodes)) {
+                // Code is indexed. OTHER FIELDS ARE NOT. Use of resourceconnection should
+                // be restricted to ONLY indexed columns
+                $predicate = $connection->quoteInto('code IN (?)', $couponCodes);
+                $deletedCouponCodes = $connection->fetchCol(
+                    $connection->select()->from($couponTable, 'code')->where($predicate)
+                );
+                $connection->delete($couponTable, $predicate);
+            }
+
+            return $deletedCouponCodes;
+        } catch (\Exception $e) {
+            throw new LocalizedException(__('Failed to delete expired/used coupon codes: %1', $e->getMessage()));
+        }
+    }
+}

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

@@ -0,0 +1,102 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Meta\Sales\Model\Api;
+
+use Magento\SalesRule\Api\RuleRepositoryInterface;
+use Magento\SalesRule\Api\Data\RuleInterface;
+use Magento\Framework\Exception\LocalizedException;
+use Meta\BusinessExtension\Helper\FBEHelper;
+use Meta\Sales\Api\DiscountRuleApiInterface;
+use Meta\Sales\Helper\OrderHelper;
+use Meta\BusinessExtension\Model\Api\CustomApiKey\Authenticator;
+
+class DiscountRuleApi implements DiscountRuleApiInterface
+{
+    /**
+     * @var RuleRepositoryInterface
+     */
+    private $ruleRepository;
+
+    /**
+     * @var FBEHelper
+     */
+    private FBEHelper $fbeHelper;
+
+    /**
+     * @var OrderHelper
+     */
+    private OrderHelper $orderHelper;
+
+    /**
+     * @var Authenticator
+     */
+    private Authenticator $authenticator;
+
+    /**
+     * DiscountRuleApi constructor.
+     *
+     * @param RuleRepositoryInterface $ruleRepository
+     * @param FBEHelper $fbeHelper
+     * @param OrderHelper $orderHelper
+     * @param Authenticator $authenticator
+     */
+    public function __construct(
+        RuleRepositoryInterface $ruleRepository,
+        FBEHelper $fbeHelper,
+        OrderHelper $orderHelper,
+        Authenticator $authenticator
+    ) {
+        $this->ruleRepository = $ruleRepository;
+        $this->fbeHelper = $fbeHelper;
+        $this->orderHelper = $orderHelper;
+        $this->authenticator = $authenticator;
+    }
+
+    /**
+     * Create a cart rule
+     *
+     * @param string $externalBusinessId
+     * @param RuleInterface $rule
+     * @return int
+     * @throws LocalizedException
+     */
+    public function createRule(string $externalBusinessId, RuleInterface $rule): string
+    {
+        $this->authenticator->authenticateRequest();
+        $storeId = $this->orderHelper->getStoreIdByExternalBusinessId($externalBusinessId);
+        try {
+            $savedRule = $this->ruleRepository->save($rule);
+            return (string)$savedRule->getRuleId();
+        } catch (\Exception $e) {
+            $this->fbeHelper->logExceptionImmediatelyToMeta(
+                $e,
+                [
+                    'store_id' => $storeId,
+                    'event' => 'create_discount_rule',
+                    'event_type' => 'rule_creation_exception',
+                    'extra_data' => [
+                        'external_business_id' => $externalBusinessId,
+                    ]
+                ]
+            );
+            throw new LocalizedException(__('Failed to create cart rule: %1', $e->getMessage()));
+        }
+    }
+}