List bounces endpoint

Author: tatevikg1

src/Endpoint/BouncesClient.php

@@ -6,6 +6,7 @@
 
 use PhpList\RestApiClient\Client;
 use PhpList\RestApiClient\Exception\ApiException;
+use PhpList\RestApiClient\Response\Bounces\BounceCollection;
 
 /**
  * Client for bounce-related API endpoints.
@@ -32,6 +33,20 @@ public function listRegex(): array
         return $this->client->get('bounces/regex');
     }
 
+    /**
+     * Get a list of all bounces.
+     *
+     * GET /api/v2/bounces
+     *
+     * @return BounceCollection
+     * @throws ApiException If an API error occurs
+     */
+    public function list(): BounceCollection
+    {
+        $response = $this->client->get('bounces');
+        return new BounceCollection($response);
+    }
+
     /**
      * Create or update a bounce regex rule.
      *
@@ -73,4 +88,18 @@ public function deleteRegexByHash(string $regexHash): array
     {
         return $this->client->delete('bounces/regex/' . rawurlencode($regexHash));
     }
+
+    /**
+     * Delete a bounce by its id.
+     *
+     * DELETE /api/v2/bounces/{bounceId}
+     *
+     * @param string $bounceId The bounce id
+     * @return array Empty response on success
+     * @throws ApiException If an API error occurs
+     */
+    public function deleteById(string $bounceId): array
+    {
+        return $this->client->delete('bounces/' . rawurlencode($bounceId));
+    }
 }

src/Entity/Bounce.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestApiClient\Entity;
+
+use PhpList\RestApiClient\Response\AbstractResponse;
+
+/**
+ * Entity representing a bounce record.
+ */
+class Bounce extends AbstractResponse
+{
+    public int $id;
+    public ?string $status = null;
+    public ?string $date = null;
+    public int $messageId;
+    public ?string $messageSubject = null;
+    public ?int $subscriberId = null;
+    public ?string $subscriberEmail = null;
+    public ?string $comment = null;
+
+    public function __construct(array $data)
+    {
+        $this->id = isset($data['id']) ? (int)$data['id'] : 0;
+        $this->status = isset($data['status']) ? (string)$data['status'] : null;
+        $this->date = isset($data['date']) ? (string)$data['date'] : null;
+        $this->messageId = isset($data['message_id']) ? (int)$data['message_id'] : 0;
+        $this->messageSubject = isset($data['message_subject']) ? (string)$data['message_subject'] : null;
+        $this->subscriberId = isset($data['subscriber_id']) ? (int)$data['subscriber_id'] : null;
+        $this->subscriberEmail = isset($data['subscriber_email']) ? (string)$data['subscriber_email'] : null;
+        $this->comment = isset($data['comment']) ? (string)$data['comment'] : null;
+    }
+}

src/Response/Bounces/BounceCollection.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestApiClient\Response\Bounces;
+
+use PhpList\RestApiClient\Entity\Bounce;
+use PhpList\RestApiClient\Response\AbstractCollectionResponse;
+
+/**
+ * Response class for a list of bounces.
+ */
+class BounceCollection extends AbstractCollectionResponse
+{
+    /**
+     * @var Bounce[] The list of bounces
+     */
+    public array $items = [];
+
+    public function __construct(array $data)
+    {
+        if (!isset($data['items']) || !is_array($data['items'])) {
+            $data = [
+                'items' => $data,
+                'pagination' => [
+                    'total' => count($data),
+                    'limit' => count($data),
+                    'has_more' => false,
+                    'next_cursor' => null,
+                ],
+            ];
+        }
+
+        parent::__construct($data);
+    }
+
+    protected function processItems(array $items): void
+    {
+        $this->items = [];
+        foreach ($items as $item) {
+            $this->items[] = new Bounce($item);
+        }
+    }
+}

tests/Endpoint/BouncesClientMethodTest.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestApiClient\Tests\Endpoint;
+
+use PhpList\RestApiClient\Client;
+use PhpList\RestApiClient\Endpoint\BouncesClient;
+use PhpList\RestApiClient\Response\Bounces\BounceCollection;
+use PHPUnit\Framework\TestCase;
+
+class BouncesClientMethodTest extends TestCase
+{
+    public function testListReturnsBounceCollection(): void
+    {
+        $mockClient = $this->createMock(Client::class);
+        $mockClient->expects($this->once())
+            ->method('get')
+            ->with('bounces')
+            ->willReturn([
+                [
+                    'id' => 10,
+                    'status' => 'not processed',
+                    'date' => '2023-01-01T12:00:00Z',
+                    'message_id' => 123,
+                    'message_subject' => 'Newsletter',
+                    'subscriber_id' => 456,
+                    'subscriber_email' => 'user@example.com',
+                    'comment' => 'Soft bounce',
+                ],
+            ]);
+
+        $bouncesClient = new BouncesClient($mockClient);
+        $result = $bouncesClient->list();
+
+        $this->assertInstanceOf(BounceCollection::class, $result);
+        $this->assertCount(1, $result->items);
+        $this->assertSame(10, $result->items[0]->id);
+        $this->assertSame(123, $result->items[0]->messageId);
+        $this->assertSame('user@example.com', $result->items[0]->subscriberEmail);
+    }
+}