fix swagger (#698)

* Fixing tests

* fixing tests

* tweak

* Static errors

* Fixing swagger docs

* EOF newline

* EOF newline2

* trailing comma

* unused interface

* protected class var

Author: sol-loup

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

@@ -0,0 +1,41 @@
+<?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;
+
+/**
+ * AddCartItemsApi response
+ */
+interface AddCartItemsApiExceptionResponseInterface
+{
+    /**
+     * Get sku which failed
+     *
+     * @return string
+     */
+    public function getSku(): string;
+
+    /**
+     * Get message for this exception
+     *
+     * @return string
+     */
+    public function getExceptionMessage(): string;
+}

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

@@ -35,7 +35,7 @@ public function getItemsAdded(): array;
     /**
      * Get array of SKU/exception message for items that failed to be added
      *
-     * @return array
+     * @return \Meta\Sales\Model\Api\AddCartItemsApiExceptionResponse[]
      */
     public function getExceptions(): array;
 }

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

@@ -48,7 +48,7 @@ interface CreateOrderApiInterface
      * @param string|null $channel
      * @param bool $buyerRemarketingOptIn
      * @param bool $createInvoice
-     * @return OrderInterface
+     * @return \Magento\Sales\Api\Data\OrderInterface
      */
     public function createOrder(
         string                                 $cartId,

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

@@ -31,7 +31,7 @@ interface NewsletterSubscriptionDiscountApiInterface
      * @param string $externalBusinessId
      * @param string $email
      * @param int $ruleId
-     * @return CouponInterface
+     * @return \Magento\SalesRule\Api\Data\CouponInterface
      */
     public function subscribeForCoupon(string $externalBusinessId, string $email, int $ruleId): CouponInterface;
 }

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

@@ -86,10 +86,7 @@ public function addCartItems(string $externalBusinessId, array $items): AddCartI
             try {
                 $itemsAdded[] = $this->guestCartItemRepository->save($item);
             } catch (\Exception $e) {
-                $exceptions[] = [
-                    'sku' => $item->getSku(),
-                    'exception_message' => $e->getMessage()
-                ];
+                $exceptions[] = new AddCartItemsApiExceptionResponse($item->getSku(), $e->getMessage());
                 $this->fbeHelper->logExceptionImmediatelyToMeta(
                     $e,
                     [

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

@@ -0,0 +1,74 @@
+<?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 Meta\Sales\Api\AddCartItemsApiExceptionResponseInterface;
+
+/**
+ * Class AddCartItemsApiExceptionResponse
+ *
+ * Implements the AddCartItemsApiExceptionResponseInterface to provide detailed information about exceptions
+ * that occur when adding items to the cart.
+ */
+class AddCartItemsApiExceptionResponse implements AddCartItemsApiExceptionResponseInterface
+{
+    /**
+     * @var string The SKU of the item that failed to be added to the cart.
+     */
+    public string $sku;
+
+    /**
+     * @var string The message associated with the exception.
+     */
+    public string $exceptionMessage;
+
+    /**
+     * Constructor for AddCartItemsApiExceptionResponse.
+     *
+     * @param string $sku The SKU of the item that failed to be added.
+     * @param string $exceptionMessage The exception message.
+     */
+    public function __construct(string $sku, string $exceptionMessage)
+    {
+        $this->sku = $sku;
+        $this->exceptionMessage = $exceptionMessage;
+    }
+
+    /**
+     * Get the SKU of the item that failed to be added to the cart.
+     *
+     * @return string The SKU of the failed item.
+     */
+    public function getSku(): string
+    {
+        return $this->sku;
+    }
+
+    /**
+     * Get the message associated with the exception.
+     *
+     * @return string The exception message.
+     */
+    public function getExceptionMessage(): string
+    {
+        return $this->exceptionMessage;
+    }
+}

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

@@ -18,34 +18,35 @@
  * limitations under the License.
  */
 
- namespace Meta\Sales\Model\Api;
+namespace Meta\Sales\Model\Api;
 
- use Meta\Sales\Api\AddCartItemsApiResponseInterface;
+use Meta\Sales\Api\AddCartItemsApiResponseInterface;
+use Meta\Sales\Api\AddCartItemsApiExceptionResponseInterface;
 
-class AddCartItemsApiResponse implements AddCartitemsApiResponseInterface
+class AddCartItemsApiResponse implements AddCartItemsApiResponseInterface
 {
     /**
-     * @var \Magento\Quote\Api\Data\CartItemInterfaceCartItemInterface[]
+     * @var \Magento\Quote\Api\Data\CartItemInterface[]
      */
     private $itemsAdded = [];
 
     /**
-     * @var array
+     * @var AddCartItemsApiExceptionResponseInterface[]
      */
     private $exceptions = [];
 
     /**
-     * Getter
+     * Getter for items added
      *
-     * @return \Magento\Quote\Api\Data\CartItemInterfaceCartItemInterface[]
+     * @return \Magento\Quote\Api\Data\CartItemInterface[]
      */
     public function getItemsAdded(): array
     {
         return $this->itemsAdded;
     }
 
     /**
-     * Setter
+     * Setter for items added
      *
      * @param \Magento\Quote\Api\Data\CartItemInterface[] $items
      * @return void
@@ -56,19 +57,19 @@ public function setItemsAdded(array $items): void
     }
 
     /**
-     * Getter
+     * Getter for exceptions
      *
-     * @return array
+     * @return AddCartItemsApiExceptionResponseInterface[]
      */
     public function getExceptions(): array
     {
         return $this->exceptions;
     }
 
     /**
-     * Setter
+     * Setter for exceptions
      *
-     * @param array $exceptions
+     * @param AddCartItemsApiExceptionResponseInterface[] $exceptions
      * @return void
      */
     public function setExceptions(array $exceptions): void