Merge pull request #44 from signnow/embedded-invite-updates

Embedded invite updates

CHANGELOG.md

@@ -5,6 +5,11 @@ 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).
 
+## [v2.2.9] - 2023-12-11
+### Added
+- New fields for Embedded Invites
+- Possibility to send custom User-Agent header
+
 ## [v2.2.8] - 2023-09-18
 ### Added
 - Endpoints for uploading and getting user's initials

sandbox/execute.php

@@ -42,13 +42,13 @@
     $document = new Document(
         $auth->bearerByPassword(BASIC_TOKEN, USER, PASSWORD)
     );
-    
+
     // 1. Upload a doc
     $documentEntity = $document->upload(dirname(__DIR__) . '/tests/_data/blank.pdf');
     echo 'Uploaded the document: ', $documentEntity->getId(), PHP_EOL, PHP_EOL;
 
     usleep(500);
-    
+
     // 2. Get the doc
     $params = (new GetDocumentRequestParams())
         ->setExclude(
@@ -68,13 +68,13 @@
     echo 'Given document name: ', $documentEntity->getDocumentName(), PHP_EOL, PHP_EOL;
 
     sleep(2);
-    
+
     // 3. Create download link
     $link = $document->createDownloadLink($documentEntity->getId());
     echo 'Download link: ', $link->getLink(), PHP_EOL, PHP_EOL;
 
     sleep(2);
-    
+
     // 4. Download the doc
     $path = DOWNLOADED_DIRECTORY_PATH . '/sign_now_downloaded_document.pdf';
     $params = (new DocumentDownloadLinkParams())
@@ -88,7 +88,7 @@
     echo 'Downloaded the document in ', $path, PHP_EOL, PHP_EOL;
 
     sleep(2);
-    
+
     // 5. Delete the doc
     $document->delete($documentEntity->getId());
     echo 'Deleted the document ', $documentEntity->getId(), PHP_EOL, PHP_EOL;

src/Action/Document.php

@@ -14,7 +14,7 @@
 use SignNow\Api\Entity\Document\Upload as DocumentUpload;
 use SignNow\Api\Entity\Document\FieldExtract as DocumentUploadFieldExtract;
 use SignNow\Rest\Entity\Binary;
-use SignNow\Rest\EntityManager;
+use SignNow\Api\Service\EntityManager\EntityManager;
 use SignNow\Rest\EntityManager\Exception\EntityManagerException;
 use SignNow\Rest\Http\Request;
 use SplFileInfo;

src/Action/DocumentGroup/DocumentGroup.php

@@ -7,7 +7,7 @@
 use ReflectionException;
 use SignNow\Api\Entity\DocumentGroup\CreateDocumentGroup;
 use SignNow\Api\Entity\DocumentGroup\DocumentGroup as DocumentGroupEntity;
-use SignNow\Rest\EntityManager;
+use SignNow\Api\Service\EntityManager\EntityManager;
 use SignNow\Rest\EntityManager\Exception\EntityManagerException;
 
 /**

src/Action/DocumentGroup/GroupInvite.php

@@ -10,7 +10,7 @@
 use SignNow\Api\Entity\DocumentGroup\GroupInvite\GroupInvite as GroupInviteEntity;
 use SignNow\Api\Entity\DocumentGroup\GroupInvite\ResponseGroupInvite;
 use SignNow\Api\Entity\Status;
-use SignNow\Rest\EntityManager;
+use SignNow\Api\Service\EntityManager\EntityManager;
 use SignNow\Rest\EntityManager\Exception\EntityManagerException;
 
 /**

src/Action/EmbeddedDocumentGroup/EmbeddedGroupInvite.php

@@ -10,7 +10,7 @@
 use SignNow\Api\Entity\Embedded\GroupInvite\DeleteEmbeddedInvites;
 use SignNow\Api\Entity\Embedded\GroupInvite\EmbeddedInvites;
 use SignNow\Api\Entity\Embedded\GroupInvite\SigningLinkResponse;
-use SignNow\Rest\EntityManager;
+use SignNow\Api\Service\EntityManager\EntityManager;
 use SignNow\Rest\EntityManager\Exception\EntityManagerException;
 
 /**

src/Action/EmbeddedInvite.php

@@ -10,9 +10,9 @@
 use SignNow\Api\Entity\Embedded\Invite\EmbeddedInvites;
 use SignNow\Api\Entity\Embedded\SigningLink\CreateSigningLink;
 use SignNow\Api\Entity\Embedded\SigningLink\SigningLink;
+use SignNow\Api\Service\EntityManager\EntityManager;
 use SignNow\Api\Service\OAuth\AuthMethod\AuthMethodInterface;
 use SignNow\Api\Service\OAuth\AuthMethod\Method\None;
-use SignNow\Rest\EntityManager;
 use SignNow\Rest\EntityManager\Exception\EntityManagerException;
 
 /**

src/Action/EventSubscription/V2/EventSubscriptionBasicToken.php

@@ -6,12 +6,11 @@
 
 use ReflectionException;
 use SignNow\Api\Action\Data\EventSubscription\V2\ActionsList;
-use SignNow\Api\Entity\EventSubscription\V2\EventCollection;
 use SignNow\Api\Entity\EventSubscription\V2\CreateEventSubscription;
 use SignNow\Api\Entity\EventSubscription\V2\DeleteEventSubscription;
+use SignNow\Api\Entity\EventSubscription\V2\EventCollection;
 use SignNow\Api\Entity\EventSubscription\V2\GetEventSubscriptions;
-use SignNow\Api\Entity\EventSubscription\V2\UpdateEventSubscription;
-use SignNow\Rest\EntityManager;
+use SignNow\Api\Service\EntityManager\EntityManager;
 use SignNow\Rest\EntityManager\Exception\EntityManagerException;
 
 /**

src/Action/EventSubscription/V2/EventSubscriptionBearerToken.php

@@ -8,7 +8,7 @@
 use SignNow\Api\Action\Data\EventSubscription\V2\ActionsList;
 use SignNow\Api\Entity\EventSubscription\V2\CreateEventSubscription;
 use SignNow\Api\Entity\EventSubscription\V2\DeleteEventSubscription;
-use SignNow\Rest\EntityManager;
+use SignNow\Api\Service\EntityManager\EntityManager;
 use SignNow\Rest\EntityManager\Exception\EntityManagerException;
 
 /**

src/Action/FillSmartFields.php

@@ -7,7 +7,7 @@
 use ReflectionException;
 use SignNow\Api\Entity\Document\SmartField\SmartField;
 use SignNow\Api\Entity\Document\SmartField\SmartFieldResponse;
-use SignNow\Rest\EntityManager;
+use SignNow\Api\Service\EntityManager\EntityManager;
 use SignNow\Rest\EntityManager\Exception\EntityManagerException;
 use SignNow\Rest\Http\Request;
 

src/Action/Invite/FieldInvite.php

@@ -13,7 +13,7 @@
 use SignNow\Api\Entity\FreeForm\InviteResponse as FreeFormResponse;
 use SignNow\Api\Entity\Invite\SigningLinkResponse;
 use SignNow\Api\Entity\Invite\SigningLink;
-use SignNow\Rest\EntityManager;
+use SignNow\Api\Service\EntityManager\EntityManager;
 use SignNow\Rest\EntityManager\Exception\EntityManagerException;
 use SignNow\Rest\Http\Request;
 

src/Action/MoveDocumentAction.php

@@ -7,7 +7,7 @@
 use ReflectionException;
 use SignNow\Api\Entity\Document\MoveDocument\MoveDocument;
 use SignNow\Api\Entity\Document\MoveDocument\MoveDocumentResponse;
-use SignNow\Rest\EntityManager;
+use SignNow\Api\Service\EntityManager\EntityManager;
 use SignNow\Rest\EntityManager\Exception\EntityManagerException;
 use SignNow\Rest\Http\Request;
 

src/Action/OAuth.php

@@ -5,11 +5,11 @@
 namespace SignNow\Api\Action;
 
 use ReflectionException;
+use SignNow\Api\Service\EntityManager\EntityManager;
 use SignNow\Api\Entity\Auth\Token;
 use SignNow\Api\Entity\Auth\TokenRequestPassword;
 use SignNow\Api\Service\Factory\EntityManagerFactory;
 use SignNow\Api\Service\Factories\TokenFactory;
-use SignNow\Rest\EntityManager;
 use SignNow\Rest\EntityManager\Exception\EntityManagerException;
 
 /**
@@ -26,12 +26,18 @@ class OAuth
      */
     private $host;
 
+    /**
+     * @var null|string
+     */
+    private $clientName;
+
     /**
      * @param string $host
      */
-    public function __construct(string $host)
+    public function __construct(string $host, ?string $clientName = null)
     {
         $this->host = $host;
+        $this->clientName = $clientName;
     }
 
     /**
@@ -43,7 +49,8 @@ public function basicAuthorization(string $basicToken): EntityManager
     {
         return (new EntityManagerFactory())->create(
             $this->host,
-            (new TokenFactory())->basicToken($basicToken)
+            (new TokenFactory())->basicToken($basicToken),
+            $this->clientName
         );
     }
 
@@ -56,7 +63,8 @@ public function bearerAuthorization(string $bearerToken): EntityManager
     {
         return (new EntityManagerFactory())->create(
             $this->host,
-            (new TokenFactory())->bearerToken($bearerToken)
+            (new TokenFactory())->bearerToken($bearerToken),
+            $this->clientName
         );
     }
 

src/Action/PrefillTextFields.php

@@ -6,7 +6,7 @@
 
 use ReflectionException;
 use SignNow\Api\Entity\Document\PrefillText\PrefillTextField;
-use SignNow\Rest\EntityManager;
+use SignNow\Api\Service\EntityManager\EntityManager;
 use SignNow\Rest\EntityManager\Exception\EntityManagerException;
 use SignNow\Rest\Http\Request;
 

src/Action/Template.php

@@ -8,7 +8,7 @@
 use SignNow\Api\Entity\Document\Document as DocumentEntity;
 use SignNow\Api\Entity\Template\Copy as TemplateCopyEntity;
 use SignNow\Api\Entity\Template\Template as TemplateEntity;
-use SignNow\Rest\EntityManager;
+use SignNow\Api\Service\EntityManager\EntityManager;
 use SignNow\Rest\EntityManager\Exception\EntityManagerException;
 
 /**

src/Action/User/Initial.php

@@ -7,7 +7,7 @@
 use ReflectionException;
 use SignNow\Api\Entity\User\Initial as UserInitialEntity;
 use SignNow\Api\Entity\User\ImageResponse;
-use SignNow\Rest\EntityManager;
+use SignNow\Api\Service\EntityManager\EntityManager;
 use SignNow\Rest\EntityManager\Exception\EntityManagerException;
 use SignNow\Rest\Http\Request;
 
@@ -42,7 +42,7 @@ public function __construct(EntityManager $entityManager)
     public function upload(string $base64ImageData): ImageResponse
     {
         $this->entityManager->setUpdateHttpMethod(Request::METHOD_PUT);
-        
+
         return $this->entityManager->update(
             new UserInitialEntity($base64ImageData)
         );

src/Action/User/Signature.php

@@ -7,7 +7,7 @@
 use ReflectionException;
 use SignNow\Api\Entity\User\Signature as UserSignatureEntity;
 use SignNow\Api\Entity\User\ImageResponse;
-use SignNow\Rest\EntityManager;
+use SignNow\Api\Service\EntityManager\EntityManager;
 use SignNow\Rest\EntityManager\Exception\EntityManagerException;
 use SignNow\Rest\Http\Request;
 
@@ -42,7 +42,7 @@ public function __construct(EntityManager $entityManager)
     public function upload(string $base64ImageData): ImageResponse
     {
         $this->entityManager->setUpdateHttpMethod(Request::METHOD_PUT);
-        
+
         return $this->entityManager->update(
             new UserSignatureEntity($base64ImageData)
         );