Merge branch 'master' into feature/add-linter-to-CI-CD

annahileta · web-flow · commit af8633fc378f · 2023-10-17T15:43:12.000+03:00
Signed-off-by: Anna Hileta &lt;80112359+annahileta@users.noreply.github.com&gt;
diff --git a/public/demo_documents/order_form.html b/public/demo_documents/order_form.html
@@ -29,7 +29,7 @@ <h4>Ordered by {signer_name}</h4>
             <tr>
                 <td style="padding: 9px 8px 0;border-bottom: 1px solid #667;">Harmonica</td>
                 <td style="padding: 9px 8px 0;border-bottom: 1px solid #667;">
-                    <span style="color:white;">/l1q/</span>
+                    <span style="color:black;">/l1q/</span>
                 </td>
                 <td style="padding: 9px 8px 0;border-bottom: 1px solid #667;">$5</td>
                 <td style="padding: 9px 8px 0;border-bottom: 1px solid #667;">
@@ -39,7 +39,7 @@ <h4>Ordered by {signer_name}</h4>
             <tr>
                 <td style="padding: 9px 8px 0;border-bottom: 1px solid #667;">Xylophone</td>
                 <td style="padding: 9px 8px 0;border-bottom: 1px solid #667;">
-                    <span style="color:white;">/l2q/</span>
+                    <span style="color:black;">/l2q/</span>
                 </td>
                 <td style="padding: 9px 8px 0;border-bottom: 1px solid #667;">$150</td>
                 <td style="padding: 9px 8px 0;border-bottom: 1px solid #667;">
diff --git a/src/Controllers/Examples/Rooms/EG008GrantOfficeAccessToFormGroup.php b/src/Controllers/Examples/Rooms/EG008GrantOfficeAccessToFormGroup.php
@@ -22,24 +22,24 @@ public function __construct()
     {
         parent::__construct();
 
-        # Step 3 Start
+        #ds-snippet-start:Rooms8Step3
         $offices = GrantOfficeAccessToFormGroupService::getOffices(
             $this->routerService,
             $this->clientService,
             $this->args,
             $this::EG
         );
-        # Step 3 End
+        #ds-snippet-end:Rooms8Step3
 
-        # Step 4 Start
+        #ds-snippet-start:Rooms8Step4
         $formGroups = GrantOfficeAccessToFormGroupService::getFormGroups(
             $this->routerService,
             $this->clientService,
             $this->args,
             $this::EG
         );
         parent::controller(null, null, null, $offices, $formGroups);
-        # Step 4 End
+        #ds-snippet-end:Rooms8Step4
     }
 
     /**
diff --git a/src/Controllers/Examples/eSignature/EG022KbAuthentication.php b/src/Controllers/Examples/eSignature/EG022KbAuthentication.php
@@ -34,7 +34,7 @@ public function __construct()
      */
     public function createController(): void
     {
-        # Step 1: Obtain your OAuth Token
+        # Obtain your OAuth Token
         $this->checkDsToken();
 
         $envelopeAuthentification = KbAuthenticationService::kbAuthentification(
diff --git a/src/Services/Examples/Admin/AuditUsersService.php b/src/Services/Examples/Admin/AuditUsersService.php
@@ -25,38 +25,38 @@ public static function auditUsers(
         array $arguments,
         string $organizationId
     ): array {
-        # Step 5a start
+        #ds-snippet-start:Admin5Step5
         $usersInformation = [];
         $userDrilldownResponse = new UsersDrilldownResponse();
-        # Step 5a end
+        #ds-snippet-end:Admin5Step5
 
         $admin_api = $clientService->getUsersApi();
 
         # Here we set the from_date to filter envelopes for the last 10 days
         # Use ISO 8601 date format
 
-        # Step 3 start
+        #ds-snippet-start:Admin5Step3
         $options = new GetUsersOptions();
         $options->setAccountId($arguments["account_id"]);
         $from_date = date("c", (time() - (10 * 24 * 60 * 60)));
         $options->setLastModifiedSince($from_date);
 
         try {
             $modifiedUsers = $admin_api->getUsers($organizationId, $options);
-            # Step 3 end
+            #ds-snippet-end:Admin5Step3
 
-            # Step 4 start
+            #ds-snippet-start:Admin5Step4
             foreach ($modifiedUsers["users"] as $user) {
                 $profileOptions = new GetUserProfilesOptions();
                 $profileOptions->setEmail($user["email"]);
-                # Step 4 end
+                #ds-snippet-end:Admin5Step4
 
-                # Step 5b start
+                #ds-snippet-start:Admin5Step5
                 $res = $admin_api->getUserProfiles($organizationId, $profileOptions);
                 $userDrilldownResponse->setUsers($res->getUsers());
                 $decoded = json_decode((string)$userDrilldownResponse, true);
                 array_push($usersInformation, $decoded["users"]);
-                # Step 5b end
+                #ds-snippet-end:Admin5Step5
             }
         } catch (ApiException $e) {
             $GLOBALS['twig']->display(
diff --git a/src/Services/Examples/Rooms/GrantOfficeAccessToFormGroupService.php b/src/Services/Examples/Rooms/GrantOfficeAccessToFormGroupService.php
@@ -16,10 +16,10 @@ class GrantOfficeAccessToFormGroupService
     public static function grantOfficeAccessToFormGroup(array $args, $clientService): void
     {
         try {
-            # Step 5 Start
+            #ds-snippet-start:Rooms8Step5
             $form_api = $clientService->getFromGroupsApi();
             $form_api->grantOfficeAccessToFormGroup($args['form_group_id'], $args['office_id'], $args["account_id"]);
-            # Step 5 End
+            #ds-snippet-end:Rooms8Step5
         } catch (ApiException $e) {
             error_log($e);
             $clientService->showErrorTemplate($e);
diff --git a/src/Services/Examples/eSignature/ApplyBrandToTemplateService.php b/src/Services/Examples/eSignature/ApplyBrandToTemplateService.php
@@ -9,22 +9,26 @@ class ApplyBrandToTemplateService
 {
     /**
      * Do the work of the example
-     * 1. Create the envelope request object
-     * 2. Send the envelope
+     * Create the envelope request object
+     * Send the envelope
      *
      * @param  $args array
      * @param $clientService
      * @return array ['envelope_id']
      */
-    # ***DS.snippet.0.start
+    
     public static function applyBrandToTemplate(array $args, $clientService): array
     {
-        # Step 3. Construct the request body
+        # Construct the request body
+        #ds-snippet-start:eSign30Step3
         $envelope_definition = ApplyBrandToTemplateService::makeEnvelope($args["envelope_args"]);
+        #ds-snippet-end:eSign30Step3
 
-        # Step 4. Call the eSignature REST API
+        # Call the eSignature REST API
+        #ds-snippet-start:eSign30Step4
         $envelope_api = $clientService->getEnvelopeApi();
         $createdEnvelope = $envelope_api->createEnvelope($args['account_id'], $envelope_definition);
+        #ds-snippet-end:eSign30Step4
 
         return ['envelope_id' => $createdEnvelope->getEnvelopeId()];
     }
@@ -35,6 +39,7 @@ public static function applyBrandToTemplate(array $args, $clientService): array
      * @param  $args array
      * @return EnvelopeDefinition -- returns an envelope definition
      */
+    #ds-snippet-start:eSign30Step3
     public static function makeEnvelope(array $args): EnvelopeDefinition
     {
         $signer = new TemplateRole([
@@ -55,5 +60,6 @@ public static function makeEnvelope(array $args): EnvelopeDefinition
             'brand_id' => $args["brand_id"], # Apply selected Brand to envelope
         ]);
     }
-    # ***DS.snippet.0.end
+    #ds-snippet-end:eSign30Step3
+    
 }
diff --git a/src/Services/Examples/eSignature/CFREmbeddedSigningService.php b/src/Services/Examples/eSignature/CFREmbeddedSigningService.php
@@ -27,13 +27,12 @@ class CFREmbeddedSigningService
      * @param SignatureClientService $clientService
      * @return array ['redirect_url']
      */
-    # ***DS.snippet.0.start
     public static function worker(array $args, SignatureClientService $clientService, string $demoPath): array
     {
 
 
         // Obtain your workflowID
-
+        #ds-snippet-start:eSign41Step2
         $accounts_api = $clientService->getAccountsApi();
         $accounts_response = $accounts_api->getAccountIdentityVerification($_SESSION['ds_account_id']);
         $workflows_data = $accounts_response->getIdentityVerification();
@@ -46,11 +45,12 @@ public static function worker(array $args, SignatureClientService $clientService
         if (!isset($args['envelope_args']['workflow_id'])) {
             $clientService->showErrorTemplate(new ApiException("IDENTITY_WORKFLOW_INVALID_ID"));
         }
+        #ds-snippet-end:eSign41Step2
 
         # Create the envelope request object
+        #ds-snippet-start:eSign41Step4
         $envelope_definition = CFREmbeddedSigningService::makeEnvelope($args['envelope_args'], $demoPath);
 
-
         $envelope_api = $clientService->getEnvelopeApi();
 
         # Call Envelopes::create API method
@@ -66,19 +66,25 @@ public static function worker(array $args, SignatureClientService $clientService
             exit;
         }
         $envelope_id = $envelopeSummary->getEnvelopeId();
+        #ds-snippet-end:eSign41Step4
 
-        # 3. Create the Recipient View request object
+        # Create the Recipient View request object
         $authentication_method = 'None'; # How is this application authenticating
         # the signer? See the `authentication_method' definition
         # https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/
+
+        #ds-snippet-start:eSign41Step5
         $recipient_view_request = $clientService->getRecipientViewRequest(
             $authentication_method,
             $args["envelope_args"]
         );
+        #ds-snippet-end:eSign41Step5
 
         # 4. Obtain the recipient_view_url for the embedded signing
         # Exceptions will be caught by the calling function
+        #ds-snippet-start:eSign41Step6
         $viewUrl = $clientService->getRecipientView($args['account_id'], $envelope_id, $recipient_view_request);
+        #ds-snippet-end:eSign41Step6
 
         return ['envelope_id' => $envelope_id, 'redirect_url' => $viewUrl['url']];
     }
@@ -90,6 +96,7 @@ public static function worker(array $args, SignatureClientService $clientService
      * @param  $args array
      * @return EnvelopeDefinition -- returns an envelope definition
      */
+    #ds-snippet-start:eSign41Step3
     private static function makeEnvelope(array $args, string $demoPath): EnvelopeDefinition
     {
         # document 1 (pdf) has tag /sn1/
@@ -170,5 +177,5 @@ private static function makeEnvelope(array $args, string $demoPath): EnvelopeDef
 
         return $envelope_definition;
     }
-    # ***DS.snippet.0.end
+    #ds-snippet-end:eSign41Step3
 }
diff --git a/src/Services/Examples/eSignature/EnvelopeInfoService.php b/src/Services/Examples/eSignature/EnvelopeInfoService.php
@@ -15,10 +15,10 @@ class EnvelopeInfoService
      * @param $clientService
      * @return Envelope
      */
-    # ***DS.snippet.0.start
-    public static function envelopeInfo(array $args, $clientService): Envelope
+    #ds-snippet-start:eSign4Step2
+     public static function envelopeInfo(array $args, $clientService): Envelope
     {
-        # 1. call API method
+        # Call API method
         # Exceptions will be caught by the calling function
         $envelope_api = $clientService->getEnvelopeApi();
         try {
@@ -30,5 +30,5 @@ public static function envelopeInfo(array $args, $clientService): Envelope
 
         return $envelopeId;
     }
-    # ***DS.snippet.0.end
+    #ds-snippet-end:eSign4Step2
 }
diff --git a/src/Services/Examples/eSignature/KbAuthenticationService.php b/src/Services/Examples/eSignature/KbAuthenticationService.php
@@ -10,24 +10,25 @@ class KbAuthenticationService
 {
     /**
      * Do the work of the example
-     * 1. Get the envelope's data
+     * Get the envelope's data
      *
      * @param  $args array
      * @param $clientService
      * @return array ['envelope_id']
      */
-    # ***DS.snippet.0.start
     public static function kbAuthentification(array $args, $clientService, $demoDocsPath): array
     {
-        # 1. Create the envelope request object
+        # Create the envelope request object
         $envelope_definition = KbAuthenticationService::makeEnvelope($args["envelope_args"], $demoDocsPath);
 
-        # 2. call Envelopes::create API method
+        # Call Envelopes::create API method
         # Exceptions will be caught by the calling function
+        #ds-snippet-start:eSign22Step4
         $envelope_api = $clientService->getEnvelopeApi();
         $envelopeResponse = $envelope_api->createEnvelope($args['account_id'], $envelope_definition);
 
         return ['envelope_id' => $envelopeResponse->getEnvelopeId()];
+        #ds-snippet-end:eSign22Step4
     }
 
     /**
@@ -38,6 +39,7 @@ public static function kbAuthentification(array $args, $clientService, $demoDocs
      * @param  $args array
      * @return mixed -- returns an envelope definition
      */
+    #ds-snippet-start:eSign22Step3
     public static function makeEnvelope(array $args, $demoDocsPath): EnvelopeDefinition
     {
         $envelopeAndSigner = RecipientAuthenticationService::constructAnEnvelope($demoDocsPath);
@@ -62,5 +64,5 @@ public static function makeEnvelope(array $args, $demoDocsPath): EnvelopeDefinit
 
         return $envelope_definition;
     }
-    # ***DS.snippet.0.end
+    #ds-snippet-end:eSign22Step3
 }
diff --git a/src/Services/Examples/eSignature/PermissionDeleteService.php b/src/Services/Examples/eSignature/PermissionDeleteService.php
@@ -15,23 +15,25 @@ class PermissionDeleteService
      * @param $clientService
      * @return string
      */
-    # ***DS.snippet.0.start
+    
     public static function permissionDelete(array $args, $clientService): string
     {
         $accounts_api = $clientService->getAccountsApi();
 
         try {
-            # Step 3. call the eSignature REST API
+            # Call the eSignature REST API
+            #ds-snippet-start:eSign27Step3
             $accounts_api->deletePermissionProfile(
                 $args['account_id'],
                 $args['permission_args']['permission_profile_id']
             );
+            #ds-snippet-end:eSign27Step3
         } catch (ApiException $e) {
             $clientService->showErrorTemplate($e);
             exit;
         }
 
         return "The permission profile has been deleted!";
     }
-    # ***DS.snippet.0.end
+    
 }

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public function __construct()`
`34`	`34`	`*/`
`35`	`35`	`public function createController(): void`
`36`	`36`	`{`
`37`		`- # Step 1: Obtain your OAuth Token`
	`37`	`+ # Obtain your OAuth Token`
`38`	`38`	`$this->checkDsToken();`
`39`	`39`
`40`	`40`	`$envelopeAuthentification = KbAuthenticationService::kbAuthentification(`
Original file line number	Diff line number	Diff line change
`@@ -15,10 +15,10 @@ class EnvelopeInfoService`
`15`	`15`	`* @param $clientService`
`16`	`16`	`* @return Envelope`
`17`	`17`	`*/`
`18`		`- # ***DS.snippet.0.start`
`19`		`- public static function envelopeInfo(array $args, $clientService): Envelope`
	`18`	`+ #ds-snippet-start:eSign4Step2`
	`19`	`+ public static function envelopeInfo(array $args, $clientService): Envelope`
`20`	`20`	`{`
`21`		`- # 1. call API method`
	`21`	`+ # Call API method`
`22`	`22`	`# Exceptions will be caught by the calling function`
`23`	`23`	`$envelope_api = $clientService->getEnvelopeApi();`
`24`	`24`	`try {`
`@@ -30,5 +30,5 @@ public static function envelopeInfo(array $args, $clientService): Envelope`
`30`	`30`
`31`	`31`	`return $envelopeId;`
`32`	`32`	`}`
`33`		`- # ***DS.snippet.0.end`
	`33`	`+ #ds-snippet-end:eSign4Step2`
`34`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,24 +10,25 @@ class KbAuthenticationService`
`10`	`10`	`{`
`11`	`11`	`/**`
`12`	`12`	`* Do the work of the example`
`13`		`- * 1. Get the envelope's data`
	`13`	`+ * Get the envelope's data`
`14`	`14`	`*`
`15`	`15`	`* @param $args array`
`16`	`16`	`* @param $clientService`
`17`	`17`	`* @return array ['envelope_id']`
`18`	`18`	`*/`
`19`		`- # ***DS.snippet.0.start`
`20`	`19`	`public static function kbAuthentification(array $args, $clientService, $demoDocsPath): array`
`21`	`20`	`{`
`22`		`- # 1. Create the envelope request object`
	`21`	`+ # Create the envelope request object`
`23`	`22`	`$envelope_definition = KbAuthenticationService::makeEnvelope($args["envelope_args"], $demoDocsPath);`
`24`	`23`
`25`		`- # 2. call Envelopes::create API method`
	`24`	`+ # Call Envelopes::create API method`
`26`	`25`	`# Exceptions will be caught by the calling function`
	`26`	`+ #ds-snippet-start:eSign22Step4`
`27`	`27`	`$envelope_api = $clientService->getEnvelopeApi();`
`28`	`28`	`$envelopeResponse = $envelope_api->createEnvelope($args['account_id'], $envelope_definition);`
`29`	`29`
`30`	`30`	`return ['envelope_id' => $envelopeResponse->getEnvelopeId()];`
	`31`	`+ #ds-snippet-end:eSign22Step4`
`31`	`32`	`}`
`32`	`33`
`33`	`34`	`/**`
`@@ -38,6 +39,7 @@ public static function kbAuthentification(array $args, $clientService, $demoDocs`
`38`	`39`	`* @param $args array`
`39`	`40`	`* @return mixed -- returns an envelope definition`
`40`	`41`	`*/`
	`42`	`+ #ds-snippet-start:eSign22Step3`
`41`	`43`	`public static function makeEnvelope(array $args, $demoDocsPath): EnvelopeDefinition`
`42`	`44`	`{`
`43`	`45`	`$envelopeAndSigner = RecipientAuthenticationService::constructAnEnvelope($demoDocsPath);`
`@@ -62,5 +64,5 @@ public static function makeEnvelope(array $args, $demoDocsPath): EnvelopeDefinit`
`62`	`64`
`63`	`65`	`return $envelope_definition;`
`64`	`66`	`}`
`65`		`- # ***DS.snippet.0.end`
	`67`	`+ #ds-snippet-end:eSign22Step3`
`66`	`68`	`}`