Merge pull request #272 from IamDejv/DGS-2727-batch-sending-stats

Add `BatchSendingsEndpoint.stats` endpoint

CHANGELOG.md

@@ -9,6 +9,8 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 - Add `BatchSendingsEndpoint.list` endpoint
 - Add `AccountSecurity.visibleAutosignRoleOption` in to resource
 - Add `AccountSecurity.visibleNoneSignerChannelOption` in to resource
+- Add `BatchSendingsEndpoint.stats` endpoint
+- Extend `BatchSending` resource
 
 ## [2.5.0] - 2024-10-14
 - Add `AccountBilling.automaticTagsPlacement`

src/Endpoint/BatchSendingsEndpoint.php

@@ -12,6 +12,7 @@
 use DigitalCz\DigiSign\Endpoint\Traits\UpdateEndpointTrait;
 use DigitalCz\DigiSign\Resource\BaseResource;
 use DigitalCz\DigiSign\Resource\BatchSending;
+use DigitalCz\DigiSign\Resource\BatchSendingStats;
 use DigitalCz\DigiSign\Resource\ListResource;
 
 /**
@@ -45,4 +46,9 @@ public function send(BatchSending|string $id): BaseResource
     {
         return $this->makeResource($this->postRequest('/{id}/send', ['id' => $id]));
     }
+
+    public function stats(BatchSending|string $id): BatchSendingStats
+    {
+        return $this->createResource($this->getRequest('/{id}/stats', ['id' => $id]), BatchSendingStats::class);
+    }
 }

src/Resource/BatchSending.php

@@ -4,6 +4,7 @@
 
 namespace DigitalCz\DigiSign\Resource;
 
+use DateTime;
 use DigitalCz\DigiSign\Resource\Traits\EntityResourceTrait;
 
 class BatchSending extends BaseResource
@@ -34,4 +35,10 @@ class BatchSending extends BaseResource
      * @var array<string>
      */
     public array $importFields;
+
+    public ?DateTime $sentAt;
+
+    public ?DateTime $finishedAt;
+
+    public ?Blame $sentBy;
 }

src/Resource/BatchSendingStats.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DigitalCz\DigiSign\Resource;
+
+class BatchSendingStats extends BaseResource
+{
+    public int $total;
+
+    public int $success;
+
+    public int $failed;
+
+    public int $waiting;
+
+    public int $sent;
+
+    public int $completed;
+
+    public int $declined;
+
+    public int $expired;
+
+    public int $cancelled;
+
+    public int $disapproved;
+
+    public int $deliveryFailed;
+
+    public int $sendSignedDocumentsFailed;
+
+    public int $identificationFailed;
+}

tests/Endpoint/BatchSendingEndpointTest.php

@@ -25,6 +25,12 @@ public function testSend(): void
         self::assertLastRequest('POST', "/api/batch-sendings/foo/send");
     }
 
+    public function testStats(): void
+    {
+        self::endpoint()->stats('foo');
+        self::assertLastRequest('GET', "/api/batch-sendings/foo/stats");
+    }
+
     protected static function endpoint(): BatchSendingsEndpoint
     {
         return self::dgs()->batchSendings();