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

Author: annahileta

composer.lock

@@ -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;">

public/demo_documents/order_form.html

@@ -38,9 +38,11 @@ public function __construct()
     protected function createController(): void
     {
         $this->checkDsToken();
+        #ds-snippet-start:Rooms6Step3
         $room_id = $this->args['room_id'];
         $form_id = $this->args['form_id'];
         $this->args['x_frame_allowed_url'] = "http://localhost:8080";
+        #ds-snippet-end:Rooms6Step3
 
         if ($room_id && !$form_id) {
             $room = CreateExternalFormFillSessionService::getRoom(
@@ -88,6 +90,7 @@ function ($f) {
                 $this->clientService
             );
 
+            #ds-snippet-start:Rooms6Step5
             if ($createExternalFormResponse) {
                 $createExternalFormJSON = json_decode((string)$createExternalFormResponse, true);
 
@@ -99,6 +102,7 @@ function ($f) {
                     $createExternalFormJSON['url'],
                 );
             }
+            #ds-snippet-end:Rooms6Step5
         }
     }
 

src/Controllers/Examples/Rooms/EG006CreateExternalFormFillSession.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
     }
 
     /**

src/Controllers/Examples/Rooms/EG008GrantOfficeAccessToFormGroup.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(

src/Controllers/Examples/eSignature/EG022KbAuthentication.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(

src/Services/Examples/Admin/AuditUsersService.php

@@ -39,13 +39,13 @@ public static function addActiveUser(
         ]);
         #ds-snippet-end:Admin1Step4
 
+        #ds-snippet-start:Admin1Step5
         $accountInfo = new NewUserRequestAccountProperties([
             'id' => $accountId,
             'permission_profile' => $permissionProfile,
             'groups' => [ $group ]
         ]);
 
-        #ds-snippet-start:Admin1Step5
         $request = new GlobalNewUserRequest([
             'user_name' => $userData['Name'],
             'first_name' => $userData['FirstName'],

src/Services/Examples/Admin/CreateNewUserService.php

@@ -8,6 +8,7 @@
 
 class CreateExternalFormFillSessionService
 {
+    #ds-snippet-start:Rooms6Step4
     public static function createExternalFormFillSession($args, $clientService)
     {
         $form_session_api = $clientService->getExternalFormFillSessionsApi();
@@ -21,6 +22,7 @@ public static function createExternalFormFillSession($args, $clientService)
         }
         return $response;
     }
+    #ds-snippet-end:Rooms6Step4
 
     /**
      * Get available Rooms

src/Services/Examples/Rooms/CreateExternalFormFillSessionService.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);

src/Services/Examples/Rooms/GrantOfficeAccessToFormGroupService.php

@@ -19,14 +19,18 @@ class AccessCodeAuthenticationService
     public static function accessCodeAuthentication(array $args, $clientService, $demoDocsPath): array
     {
         # 1. Create the envelope request object
-        $envelope_definition = AccessCodeAuthenticationService::makeEnvelope($args["envelope_args"], $demoDocsPath);
+        #ds-snippet-start:eSign19Step3
+        $envelope_definition = AccessCodeAuthenticationService::make_envelope($args["envelope_args"], $demoDocsPath);
+        #ds-snippet-end:eSign19Step3
 
         # 2. call Envelopes::create API method
         # Exceptions will be caught by the calling function
+        #ds-snippet-start:eSign19Step4
         $envelope_api = $clientService->getEnvelopeApi();
         $createdEnvelope = $envelope_api->createEnvelope($args['account_id'], $envelope_definition);
 
         return ['envelope_id' => $createdEnvelope->getEnvelopeId()];
+        #ds-snippet-end:eSign19Step4
     }
 
     /**
@@ -37,6 +41,7 @@ public static function accessCodeAuthentication(array $args, $clientService, $de
      * @param  $args array
      * @return mixed -- returns an envelope definition
      */
+    #ds-snippet-start:eSign19Step3
     public static function makeEnvelope(array $args, $demoDocsPath): EnvelopeDefinition
     {
         $envelopeAndSigner = RecipientAuthenticationService::constructAnEnvelope($demoDocsPath);
@@ -62,4 +67,5 @@ public static function makeEnvelope(array $args, $demoDocsPath): EnvelopeDefinit
 
         return $envelope_definition;
     }
+    #ds-snippet-end:eSign19Step3
 }