Merge pull request #33 from signnow/add-update-document-name-action-v1

Add update document name action (v1)

Author: JiSoft

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+## [v1.5.6] - 2023-02-28
+### Added
+- Action to modify document name
+
 ## [v1.5.5] - 2022-11-22
 ### Added
 - Support move document 

README.md

@@ -21,6 +21,7 @@ Simple API Client to integrate SignNow with your application or website. Sign do
       * [Retrieve document](#retrieve-document)
       * [Delete document](#delete-document)
       * [Download document](#download-document)
+      * [Modify document name](#modify-document-name)
       * [Create a single-use link for document downloading](#document-download-link)
       * [Create a role-based invite to sign a document](#role-invite-document)
       * [Create a simple free form invite to sign a document](#free-form-invite-document)
@@ -212,6 +213,24 @@ $entityManager->get(new DocumentDownload(), ['id' => $documentUniqueId], ['type'
 // if need table containing the document's history set with_history=1
 $entityManager->get(new DocumentDownload(), ['id' => $documentUniqueId], ['type' => 'collapsed', 'with_history' => 1]);
 ```
+#### <a name="modify-document-name"></a>Modify document name
+```php
+use SignNow\Api\Action\Document;
+use SignNow\Api\Action\OAuth as SignNowOAuth;
+
+$auth = new SignNowOAuth(HOST);
+$entityManager = $auth->bearerByPassword(
+    BASIC_TOKEN,
+    USER,
+    PASSWORD
+);
+
+$documentUniqueId = 'd136ce0211a74a808de9fefe7249446fe452e566';
+$documentName = 'Your document name to be modified';
+
+$document = new Document($entityManager);
+$documentEntity = $document->modifyName($documentUniqueId, $documentName);
+```
 #### <a name="document-download-link"></a>Create a single-use link for document downloading
  ```php
 use SignNow\Api\Entity\Document\DownloadLink;

src/Action/Document.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace SignNow\Api\Action;
@@ -42,7 +43,7 @@ public function __construct(EntityManager $entityManager)
 
     /**
      * @param string $filePath
-     * 
+     *
      * @return DocumentEntity|object
      * @throws ReflectionException
      * @throws EntityManagerException
@@ -70,7 +71,7 @@ public function uploadWithTags(string $filePath, array $textTags): DocumentEntit
         foreach ($textTags as $textTag) {
             $tags[] = $textTag->toArray();
         }
-        
+
         return $this->entityManager->create(new DocumentUploadFieldExtract(new SplFileInfo($filePath), $tags));
     }
 
@@ -106,12 +107,12 @@ public function addFields(string $documentUniqueId, array $fields): DocumentEnti
         $document = new DocumentEntity();
         $document->setId($documentUniqueId);
         $document->setFields($fields);
-        
+
         $this->entityManager->setUpdateHttpMethod(Request::METHOD_PUT);
-        
+
         return $this->entityManager->update($document);
     }
-    
+
     /**
      * @param string $documentUniqueId
      *
@@ -128,7 +129,7 @@ public function delete(string $documentUniqueId): void
             ]
         );
     }
-    
+
     /**
      * @param string $documentUniqueId
      * @param DocumentDownloadLinkParams|null $queryParams
@@ -150,7 +151,7 @@ public function download(string $documentUniqueId, ?DocumentDownloadLinkParams $
 
     /**
      * Create a single-use link for document downloading
-     * 
+     *
      * @param string $documentUniqueId
      *
      * @return object|DocumentDownloadLink
@@ -166,4 +167,22 @@ public function createDownloadLink(string $documentUniqueId): DocumentDownloadLi
             ]
         );
     }
+
+    /**
+     * @param string $newDocumentName
+     * @param string $documentUniqueId
+     *
+     * @return DocumentEntity|object
+     * @throws EntityManagerException
+     * @throws ReflectionException
+     */
+    public function modifyName(string $documentUniqueId, string $newDocumentName): DocumentEntity
+    {
+        $document = new DocumentEntity();
+        $document->setId($documentUniqueId);
+        $document->setDocumentName($newDocumentName);
+        $this->entityManager->setUpdateHttpMethod(Request::METHOD_PUT);
+
+        return $this->entityManager->update($document);
+    }
 }

tests/functional/Document/UpdateDocumentCest.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace SignNow\Tests\Functional\Document;
@@ -89,4 +90,24 @@ public function testAddFields(FunctionalTester $I): void
 
         $I->assertSame($documentUniqueId, $documentEntity->getId());
     }
+
+    /**
+     * @param FunctionalTester $I
+     *
+     * @return void
+     * @throws EntityManagerException
+     * @throws ReflectionException
+     */
+    public function testUpdateDocumentName(FunctionalTester $I): void
+    {
+        $document = new Document($this->auth);
+
+        $documentUniqueId = $I->createUniqueId();
+
+        $I->mockUpdateDocumentRequest($documentUniqueId);
+        
+        $documentEntity = $document->modifyName($documentUniqueId, 'Updated Cool Name');
+
+        $I->assertSame($documentUniqueId, $documentEntity->getId());
+    }
 }