Implemented new code examples for Admin SDK (#78)

* fixed the namings for the input properties
* Added new admin code examples
* changed a case for properties
* added a check if account has been deleted

Author: annahileta

composer.json

@@ -6,7 +6,7 @@
     },
 
     "require": {
-        "docusign/admin-client": "1.0.0",
+        "docusign/admin-client": "1.1.0",
         "docusign/click-client": "1.1.0",
         "docusign/esign-client": "6.8.0",
         "docusign/rooms-client": "2.0.0",

composer.lock

@@ -0,0 +1,25 @@
+$(document).ready(function () {
+    $("#Products").on("change", function () {
+        $list = $("#PermissionProfilesFiltered");
+
+        let json_raw = $("#PermissionProfilesData").attr("data-value"),
+            json = json_raw ? JSON.parse(json_raw) : false;
+
+        if (json) {
+            $list.empty();
+            $.each(json, function (key, product) {
+                if(key === $("#Products option:selected").html()){
+                    $.each(product, function (i, permissionProfile) {
+                        $list.append(
+                            '<option value="' 
+                            + permissionProfile["permission_profile_id"] 
+                            + '"> ' 
+                            + permissionProfile["permission_profile_name"] 
+                            + ' </option>'
+                        );
+                    });
+                }
+            });
+        }
+    });
+});

public/assets/site.js

@@ -82,7 +82,7 @@ private function getController(
                     'args' => $args,
                     'permission_profiles' => $permission_profiles,
                     'export_id' => isset($_SESSION['export_id']),
-                    'import_id' => isset($_SESSION['import_id'])
+                    'import_id' => isset($_SESSION['import_id']),
                 ]);
             }
             else {
@@ -121,5 +121,15 @@ protected function getDefaultTemplateArgs(): array
         ];
     }
 
+    /**
+     * Check input values using regular expressions
+     * @param $value
+     * @return string
+     */
+    protected function checkInputValues($value): string
+    {
+        return preg_replace('/([^\w \-\@\.\,])+/', '', $value);
+    }
+
     abstract function getTemplateArgs(): array;
 }

src/Controllers/AdminApiBaseController.php

@@ -85,6 +85,8 @@ public function createController(): void
         );
 
         if ($addUsersResponse) {
+            $_SESSION['email_address'] = strval($addUsersResponse->getEmail());
+
             $addUsersResponse = json_decode((string)$addUsersResponse, true);
             $this->clientService->showDoneTemplate(
                 "Create a new active user for CLM and eSignature",

src/Controllers/Examples/Admin/EG002CreateActiveCLMESignUser.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace Example\Controllers\Examples\Admin;
+
+use DocuSign\Admin\Client\ApiException;
+use Example\Controllers\AdminApiBaseController;
+use Example\Services\Examples\Admin\RetrieveDocuSignProfileByEmailAddress;
+
+class EG006RetrieveDocuSignProfileByEmailAddress extends AdminApiBaseController
+{
+    const EG = 'aeg006'; # reference (and url) for this example
+
+    const FILE = __FILE__;
+
+    /**
+     * Create a new controller instance
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        parent::__construct();
+
+        parent::controller();
+    }
+
+    /**
+     * 1. Check the token
+     * 2. Call the worker method
+     *
+     * @return void
+     */
+    public function createController(): void
+    {
+        $this->checkDsToken();
+
+        try {
+            $organizationId = $this->clientService->getOrgAdminId();
+
+            $usersResponse = RetrieveDocuSignProfileByEmailAddress::getDocuSignProfileByEmailAddress(
+                $organizationId,
+                $this->args["email"],
+                $this->clientService);
+
+            $this->clientService->showDoneTemplate(
+                "Retrieve the user's DocuSign profile using an email address",
+                "Retrieve the user's DocuSign profile using an email address",
+                "Results from MultiProductUserManagement:getUserDSProfilesByEmail method:",
+                json_encode(json_encode($usersResponse))
+            );
+        } catch (ApiException $e) {
+            $this->clientService->showErrorTemplate($e);
+        }
+    }
+
+    /**
+     * Get specific template arguments
+     *
+     * @return array
+     */
+    public function getTemplateArgs(): array
+    {
+        return [
+            'email' => $this->checkInputValues($_POST['email']),
+            'account_id' => $_SESSION['ds_account_id'],
+            'ds_access_token' => $_SESSION['ds_access_token']
+        ];
+    }
+}

src/Controllers/Examples/Admin/EG006RetrieveDocuSignProfileByEmailAddress.php

@@ -0,0 +1,66 @@
+<?php
+
+namespace Example\Controllers\Examples\Admin;
+
+use DocuSign\Admin\Client\ApiException;
+use Example\Controllers\AdminApiBaseController;
+use Example\Services\Examples\Admin\RetrieveDocuSignProfileByUserId;
+
+class EG007RetrieveDocuSignProfileByUserID extends AdminApiBaseController
+{
+    const EG = 'aeg007'; # reference (and url) for this example
+
+    const FILE = __FILE__;
+
+    /**
+     * Create a new controller instance
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        parent::__construct();
+
+        parent::controller();
+    }
+
+    /**
+     * 1. Check the token
+     * 2. Call the worker method
+     *
+     * @return void
+     */
+    public function createController(): void
+    {
+        $this->checkDsToken();
+
+        try {
+            $organizationId = $this->clientService->getOrgAdminId();
+            $usersResponse = RetrieveDocuSignProfileByUserId::getDocuSignProfileByUserId(
+                $organizationId, $this->args["user_id"], $this->clientService);
+
+            $this->clientService->showDoneTemplate(
+                "Retrieve the user's DocuSign profile using a User ID",
+                "Retrieve the user's DocuSign profile using a User ID",
+                "Results from MultiProductUserManagement:getUserDSProfile method:",
+                json_encode(json_encode($usersResponse))
+            );
+        } catch (ApiException $e) {
+            $this->clientService->showErrorTemplate($e);
+        }
+    }
+
+    /**
+     * Get specific template arguments
+     *
+     * @return array
+     */
+    public function getTemplateArgs(): array
+    {
+        return [
+            'user_id' => $this->checkInputValues($_POST['user_id']),
+            'account_id' => $_SESSION['ds_account_id'],
+            'ds_access_token' => $_SESSION['ds_access_token']
+        ];
+    }
+}