Bounce controller: by campaign/subscriber endpoints

Author: tatevikg1

src/Messaging/Controller/BounceController.php

@@ -8,6 +8,7 @@
 use OpenApi\Attributes as OA;
 use PhpList\Core\Domain\Messaging\Model\Bounce;
 use PhpList\Core\Domain\Messaging\Repository\BounceRepository;
+use PhpList\Core\Domain\Messaging\Repository\UserMessageBounceRepository;
 use PhpList\Core\Security\Authentication;
 use PhpList\RestBundle\Common\Controller\BaseController;
 use PhpList\RestBundle\Common\Service\Provider\PaginatedDataProvider;
@@ -33,6 +34,7 @@ public function __construct(
         private readonly EntityManagerInterface $entityManager,
         private readonly BounceNormalizer $normalizer,
         private readonly PaginatedDataProvider $paginatedProvider,
+        private readonly UserMessageBounceRepository $userMessageBounceRepository
     ) {
         parent::__construct($authentication, $validator);
     }
@@ -158,4 +160,104 @@ public function delete(
 
         return $this->json(null, Response::HTTP_NO_CONTENT);
     }
+
+    #[Route('/by/campaign', name: 'get_by_campaign', methods: ['GET'])]
+    #[OA\Get(
+        path: '/api/v2/bounces/by/campaign',
+        description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. ' .
+        'Returns a JSON list of bounce counts by campaign.',
+        summary: 'Gets a list of bounce counts by campaign.',
+        tags: ['bounces'],
+        parameters: [
+            new OA\Parameter(
+                name: 'php-auth-pw',
+                description: 'Session key obtained from login',
+                in: 'header',
+                required: true,
+                schema: new OA\Schema(type: 'string')
+            ),
+        ],
+        responses: [
+            new OA\Response(
+                response: 200,
+                description: 'Success',
+                content: new OA\JsonContent(
+                    type: 'array',
+                    items: new OA\Items(
+                        properties: [
+                            new OA\Property(property: 'message_id', type: 'integer', example: 1),
+                            new OA\Property(property: 'subject', type: 'string', example: 'System'),
+                            new OA\Property(property: 'total_bounces', type: 'integer', example: 3),
+                        ],
+                        type: 'object'
+                    )
+                )
+            ),
+            new OA\Response(
+                response: 403,
+                description: 'Failure',
+                content: new OA\JsonContent(ref: '#/components/schemas/UnauthorizedResponse')
+            )
+        ]
+    )]
+    public function getBounceCountsByCampaign(Request $request): JsonResponse
+    {
+        $authUser = $this->requireAuthentication($request);
+
+        return $this->json(
+            data: $this->userMessageBounceRepository->getCampaignBounceTotals($authUser->getId()),
+            status: Response::HTTP_OK
+        );
+    }
+
+    #[Route('/by/subscriber', name: 'get_by_subscriber', methods: ['GET'])]
+    #[OA\Get(
+        path: '/api/v2/bounces/by/subscriber',
+        description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. ' .
+        'Returns a JSON list of bounce counts by subscriber.',
+        summary: 'Gets a list of bounce counts by subscriber.',
+        tags: ['bounces'],
+        parameters: [
+            new OA\Parameter(
+                name: 'php-auth-pw',
+                description: 'Session key obtained from login',
+                in: 'header',
+                required: true,
+                schema: new OA\Schema(type: 'string')
+            ),
+        ],
+        responses: [
+            new OA\Response(
+                response: 200,
+                description: 'Success',
+                content: new OA\JsonContent(
+                    type: 'array',
+                    items: new OA\Items(
+                        properties: [
+                            new OA\Property(property: 'subscriber_id', type: 'integer', example: 1),
+                            new OA\Property(property: 'email', type: 'string', example: 'example@email.com'),
+                            new OA\Property(property: 'confirmed', type: 'boolean', example: true),
+                            new OA\Property(property: 'blacklisted', type: 'boolean', example: true),
+                            new OA\Property(property: 'total_bounces', type: 'integer', example: 3),
+                        ],
+                        type: 'object'
+                    )
+                )
+            ),
+            new OA\Response(
+                response: 403,
+                description: 'Failure',
+                content: new OA\JsonContent(ref: '#/components/schemas/UnauthorizedResponse')
+            )
+        ]
+    )]
+    public function getBounceCountsBySubscriber(Request $request): JsonResponse
+    {
+        $authUser = $this->requireAuthentication($request);
+
+        return $this->json(
+            data: $this->userMessageBounceRepository->getListBounceTotals($authUser->getId()),
+            status: Response::HTTP_OK
+        );
+    }
 }