Merge pull request #296 from digitalcz/DGS-3010-multisign-to-bulksign…

…ature-renaming Renamed MultiSing into BulkSignature
digitalcz · Feb 4, 2025 · c60cd43 · c60cd43
2 parents 321b750 + 0279afe
commit c60cd43
Show file tree

Hide file tree

Showing 11 changed files with 46 additions and 46 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,8 +8,8 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 - Edit `AccountGuide.settingsFilled`
 - Add `MyPreferences.guideHide`
 - Add `Account.guide` endpoint and `AccountGuide` resource
-- Add `AccountBilling.multiSign`
-- Edit `MultiSignRecipientInfo` resource
+- Add `AccountBilling.bulkSigning`
+- Edit `BulkSignatureRecipientInfo` resource
 - Add `BatchSendingsEndpoint.MutiSignRecipients` endpoint
 - Add `MyEndpoint.updatePreferences` endpoint and `MyPreferences` resource
 - Add `SignatureScenarioVersionInfo.role`
@@ -28,7 +28,7 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 - Add `AccountEndpoint.createDefaultSubscription` endpoint
 - Add `SignatureScenario.latestVersionInfo`
 - Add `EnvelopeTemplateTag`.`customIdentifier` in to resource
-- Add `MultiSign.get` endpoint
+- Add `BulkSignature.get` endpoint
 
 ## [2.5.0] - 2024-10-14
 - Add `AccountBilling.automaticTagsPlacement`

diff --git a/src/DigiSign.php b/src/DigiSign.php
@@ -10,6 +10,7 @@
 use DigitalCz\DigiSign\Endpoint\AccountEndpoint;
 use DigitalCz\DigiSign\Endpoint\AuthEndpoint;
 use DigitalCz\DigiSign\Endpoint\BatchSendingsEndpoint;
+use DigitalCz\DigiSign\Endpoint\BulkSignatureEndpoint;
 use DigitalCz\DigiSign\Endpoint\DeliveriesEndpoint;
 use DigitalCz\DigiSign\Endpoint\EndpointInterface;
 use DigitalCz\DigiSign\Endpoint\EnumsEndpoint;
@@ -19,7 +20,6 @@
 use DigitalCz\DigiSign\Endpoint\IdentificationsEndpoint;
 use DigitalCz\DigiSign\Endpoint\ImagesEndpoint;
 use DigitalCz\DigiSign\Endpoint\LabelsEndpoint;
-use DigitalCz\DigiSign\Endpoint\MultiSignEndpoint;
 use DigitalCz\DigiSign\Endpoint\MyEndpoint;
 use DigitalCz\DigiSign\Endpoint\ReportEndpoint;
 use DigitalCz\DigiSign\Endpoint\WebhooksEndpoint;
@@ -290,9 +290,9 @@ public function report(): ReportEndpoint
         return new ReportEndpoint($this);
     }
 
-    public function multiSign(): MultiSignEndpoint
+    public function bulkSignature(): BulkSignatureEndpoint
     {
-        return new MultiSignEndpoint($this);
+        return new BulkSignatureEndpoint($this);
     }
 
     private function createUserAgent(): string

diff --git a/src/Endpoint/BatchSendingsEndpoint.php b/src/Endpoint/BatchSendingsEndpoint.php
@@ -13,9 +13,9 @@
 use DigitalCz\DigiSign\Resource\BaseResource;
 use DigitalCz\DigiSign\Resource\BatchSending;
 use DigitalCz\DigiSign\Resource\BatchSendingStats;
+use DigitalCz\DigiSign\Resource\BulkSignatureRecipientInfo;
 use DigitalCz\DigiSign\Resource\Collection;
 use DigitalCz\DigiSign\Resource\ListResource;
-use DigitalCz\DigiSign\Resource\MultiSignRecipientInfo;
 
 /**
  * @extends ResourceEndpoint<BatchSending>
@@ -55,13 +55,13 @@ public function stats(BatchSending|string $id): BatchSendingStats
     }
 
     /**
-     * @return Collection<MultiSignRecipientInfo>
+     * @return Collection<BulkSignatureRecipientInfo>
      */
-    public function multiSignRecipients(BatchSending|string $id): Collection
+    public function bulkSignatureRecipients(BatchSending|string $id): Collection
     {
         return $this->createCollectionResource(
-            $this->getRequest('/{id}/multi-sign-recipients', ['id' => $id]),
-            MultiSignRecipientInfo::class,
+            $this->getRequest('/{id}/bulk-signature-recipients', ['id' => $id]),
+            BulkSignatureRecipientInfo::class,
         );
     }
 }
diff --git a/src/Endpoint/MultiSignEndpoint.php → src/Endpoint/BulkSignatureEndpoint.php b/src/Endpoint/MultiSignEndpoint.php → src/Endpoint/BulkSignatureEndpoint.php
@@ -6,17 +6,17 @@
 
 use DigitalCz\DigiSign\DigiSign;
 use DigitalCz\DigiSign\Endpoint\Traits\GetEndpointTrait;
-use DigitalCz\DigiSign\Resource\MultiSign;
+use DigitalCz\DigiSign\Resource\BulkSignature;
 
 /**
- * @extends ResourceEndpoint<MultiSign>
+ * @extends ResourceEndpoint<BulkSignature>
  */
-final class MultiSignEndpoint extends ResourceEndpoint
+final class BulkSignatureEndpoint extends ResourceEndpoint
 {
     use GetEndpointTrait;
 
     public function __construct(DigiSign $parent)
     {
-        parent::__construct($parent, '/api/multi-signs', MultiSign::class);
+        parent::__construct($parent, '/api/bulk-signatures', BulkSignature::class);
     }
 }
diff --git a/src/Resource/AccountBilling.php b/src/Resource/AccountBilling.php
@@ -66,5 +66,5 @@ class AccountBilling extends BaseResource
 
     public bool $automaticTagsPlacement;
 
-    public bool $multiSign;
+    public bool $bulkSigning;
 }
diff --git a/src/Resource/MultiSign.php → src/Resource/BulkSignature.php b/src/Resource/MultiSign.php → src/Resource/BulkSignature.php
@@ -7,7 +7,7 @@
 use DateTime;
 use DigitalCz\DigiSign\Resource\Traits\EntityResourceTrait;
 
-final class MultiSign extends BaseResource
+final class BulkSignature extends BaseResource
 {
     use EntityResourceTrait;
 

diff --git a/src/Resource/MultiSignRecipientInfo.php → src/Resource/BulkSignatureRecipientInfo.php b/src/Resource/MultiSignRecipientInfo.php → src/Resource/BulkSignatureRecipientInfo.php
@@ -4,7 +4,7 @@
 
 namespace DigitalCz\DigiSign\Resource;
 
-class MultiSignRecipientInfo extends BaseResource
+class BulkSignatureRecipientInfo extends BaseResource
 {
     public string $name;
 
@@ -14,5 +14,5 @@ class MultiSignRecipientInfo extends BaseResource
 
     public int $count;
 
-    public bool $isMultiSignable;
+    public bool $isBulkSignable;
 }
diff --git a/tests/DigiSignTest.php b/tests/DigiSignTest.php
@@ -156,8 +156,8 @@ public function testChildren(): void
         self::assertSame('/api/my', $mockClient->getLastRequest()->getUri()->getPath());
         $dgs->report()->request('GET');
         self::assertSame('/api/report', $mockClient->getLastRequest()->getUri()->getPath());
-        $dgs->multiSign()->request('GET');
-        self::assertSame('/api/multi-signs', $mockClient->getLastRequest()->getUri()->getPath());
+        $dgs->bulkSignature()->request('GET');
+        self::assertSame('/api/bulk-signatures', $mockClient->getLastRequest()->getUri()->getPath());
     }
 
     public function testUserAgent(): void

diff --git a/tests/Endpoint/BatchSendingEndpointTest.php b/tests/Endpoint/BatchSendingEndpointTest.php
@@ -31,10 +31,10 @@ public function testStats(): void
         self::assertLastRequest('GET', "/api/batch-sendings/foo/stats");
     }
 
-    public function testMultiSignRecipients(): void
+    public function testBulkSignatureRecipients(): void
     {
-        self::endpoint()->multiSignRecipients('foo');
-        self::assertLastRequest('GET', "/api/batch-sendings/foo/multi-sign-recipients");
+        self::endpoint()->bulkSignatureRecipients('foo');
+        self::assertLastRequest('GET', "/api/batch-sendings/foo/bulk-signature-recipients");
     }
 
     protected static function endpoint(): BatchSendingsEndpoint

diff --git a/tests/Endpoint/BulkSignatureEndpointTest.php b/tests/Endpoint/BulkSignatureEndpointTest.php
@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DigitalCz\DigiSign\Endpoint;
+
+/**
+ * @covers \DigitalCz\DigiSign\Endpoint\BulkSignatureEndpoint
+ */
+final class BulkSignatureEndpointTest extends EndpointTestCase
+{
+    public function testGet(): void
+    {
+        self::endpoint()->get('foo');
+        self::assertLastRequest('GET', '/api/bulk-signatures/foo');
+    }
+
+    protected static function endpoint(): BulkSignatureEndpoint
+    {
+        return self::dgs()->bulkSignature();
+    }
+}
diff --git a/tests/Endpoint/MultiSignEndpointTest.php b/tests/Endpoint/MultiSignEndpointTest.php