Added post web query code example (#69)

* Added the post web query code example

* fixed code style issues

* removed extra spaces

Author: annahileta

composer.json

@@ -10,7 +10,7 @@
         "docusign/click-client": "1.1.0",
         "docusign/esign-client": "6.8.0",
         "docusign/rooms-client": "2.0.0",
-        "docusign/monitor-client": "1.0.0",    
+        "docusign/monitor-client": "1.1.0",
         "twig/twig": "3.3.8",
         "league/oauth2-client": "2.6.1",
         "ext-json": "*",

composer.lock

@@ -0,0 +1,69 @@
+<?php
+
+namespace Example\Controllers\Examples\Monitor;
+
+use Example\Controllers\MonitorBaseController;
+use Example\Services\Examples\Monitor\WebQueryEndpointService;
+use Example\Services\JWTService;
+
+class Eg002WebQueryEndpoint extends MonitorBaseController
+{
+    const EG = 'meg002'; # reference (and URL) for this example
+    const FILE = __FILE__;
+
+    /**
+     * Create a new controller instance.
+     * @return void
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        parent::controller();
+    }
+
+    /**
+     * Check the access token and call the worker method
+     * @return void
+     */
+    public function createController(): void
+    {
+        $accessToken = $_SESSION['ds_access_token'];
+        $tokenExpirationTime = $_SESSION['ds_expiration'];
+        if (
+            is_null($accessToken) ||
+            (time() + JWTService::TOKEN_REPLACEMENT_IN_SECONDS) > $tokenExpirationTime
+        ) {
+            $auth = new JWTService();
+            $auth->login();
+        } else {
+            $monitoringData = WebQueryEndpointService::postWebQueryMethod(
+                $this->clientService,
+                $this->args['account_id'],
+                $this->args['start_date'],
+                $this->args['end_date']
+            );
+
+            if ($monitoringData) {
+                $this->clientService->showDoneTemplate(
+                    "Post web query",
+                    "Query monitoring data with filters",
+                    "Results from DataSet:postWebQuery method:",
+                    json_encode($monitoringData)
+                );
+            }
+        }
+    }
+
+    /**
+     * Get specific template arguments
+     * @return array
+     */
+    public function getTemplateArgs(): array
+    {
+        return [
+            'account_id' => $_SESSION['ds_account_id'],
+            'start_date' => $this->checkInputValues($_POST['start_date']),
+            'end_date' => $this->checkInputValues($_POST['end_date'])
+        ];
+    }
+}

src/Controllers/Examples/Monitor/Eg002WebQueryEndpoint.php

@@ -83,8 +83,19 @@ private function getController(
      */
 
     abstract function createController(): void;
-    
+
+    /**
+     * Check input values using regular expressions
+     * @param $value
+     * @return string
+     */
+    protected function checkInputValues($value): string
+    {
+        return preg_replace('/([^\w \-\@\.\,])+/', '', $value);
+    }
+
     /**
+     * Provides the default template arguments
      * @return array
      */
     protected function getDefaultTemplateArgs(): array

src/Controllers/MonitorBaseController.php

@@ -0,0 +1,75 @@
+<?php
+
+namespace Example\Services\Examples\Monitor;
+
+use DocuSign\Monitor\Api\DataSetApi;
+use DocuSign\Monitor\Model\WebQuery;
+use DocuSign\Monitor\Client\ApiException;
+use Example\Services\MonitorApiClientService;
+
+class WebQueryEndpointService
+{
+    /**
+     * Method to get companies data from monitor
+     * @param MonitorApiClientService $clientService
+     * @param string $accountId
+     * @param string $filterStartDate
+     * @param string $filterEndDate
+     * @return array
+     */
+    public static function postWebQueryMethod(
+        MonitorApiClientService $clientService,
+        string $accountId,
+        string $filterStartDate,
+        string $filterEndDate): array
+    {
+        // Create an ApiClient and construct API headers
+        $apiClient = $clientService->getApiClient();
+
+        try {
+            $datasetApi = new DataSetApi($apiClient);
+
+            $webQueryResult = $datasetApi->postWebQuery(
+                'monitor',
+                '2.0',
+                self::preparePostWebQuery($accountId, $filterStartDate, $filterEndDate)
+            );
+
+        } catch (ApiException $e) {
+            $clientService->showErrorTemplate($e);
+            exit;
+        }
+
+        // Cleaning the data from unsupported symbols
+        return str_replace("'", "", $webQueryResult->getResult());
+    }
+
+    public static function preparePostWebQuery(string $accountId, string $filterStartDate, string $filterEndDate): WebQuery
+    {
+        $webQueryOptions = new WebQuery();
+
+        $datesFilter = (object)[
+            "FilterName" => "Time",
+            "BeginTime" => $filterStartDate,
+            "EndTime" => $filterEndDate
+        ];
+
+        $accountIdFilter = (object)[
+            "FilterName" => "Has",
+            "ColumnName" => "AccountId",
+            "Value" => $accountId
+        ];
+
+        $webQueryOptions->setFilters([$datesFilter, $accountIdFilter]);
+
+        $aggregation = (object)[
+            "aggregationName" => "Raw",
+            "limit" => "1",
+            "orderby" => ["Timestamp, desc"]
+        ];
+
+        $webQueryOptions->setAggregations([$aggregation]);
+
+        return $webQueryOptions;
+    }
+}

src/Services/Examples/Monitor/WebQueryEndpointService.php

@@ -30,7 +30,7 @@ public function __construct($args)
         # Exceptions will be caught by the calling function
         # step 2 start
         $config = new Configuration();
-        $accessToken = $args['ds_access_token'];
+        $accessToken = $_SESSION['ds_access_token'];
 
         $config->setAccessToken($accessToken);
         $config->setHost('https://lens-d.docusign.net');

src/Services/MonitorApiClientService.php

@@ -69,6 +69,7 @@ class RouterService
         'reg008' => 'Rooms\EG008GrantOfficeAccessToFormGroup',
         'reg009' => 'Rooms\Eg009AssignFormToFormGroup',
         'meg001' => 'Monitor\Eg001GetMonitoringData',
+        'meg002' => 'Monitor\Eg002WebQueryEndpoint',
         'aeg001' => 'Admin\EG001CreateNewUser',
         'aeg002' => 'Admin\EG002CreateActiveCLMESignUser',
         'aeg003' => 'Admin\EG003BulkExportUserData',
@@ -141,6 +142,7 @@ class RouterService
         "reg008" => "rooms/eg008_grant_office_access_to_form_group.html",
         "reg009" => "rooms/eg009_assign_form_to_form_group.html",
         "meg001" => "monitor/eg001_get_monitoring_data.html",
+        "meg002" => "monitor/eg002_web_query_endpoint.html",
         "aeg001" => "admin/eg001_create_active_user.html",
         "aeg002" => "admin/eg002_create_new_esignature_clm_user.html",
         "aeg003" => "admin/eg003_bulk_export_user_data.html",
@@ -210,6 +212,7 @@ class RouterService
         "reg008" => "Grant office access to a form group",
         "reg009" => "Assign a form to a form group",
         "meg001" => "Get monitoring data",
+        "meg002" => "Post web query",
         "aeg001" => "Create a new user with active status",
         "aeg002" => "Create a new active user for CLM and eSignature",
         "aeg003" => "How to bulk-export user data",

src/Services/RouterService.php

@@ -31,6 +31,15 @@ <h4 id="example-c001">
     <p>API method used: 
         <a target='_blank' href="https://developers.docusign.com/docs/monitor-api/reference/monitor/dataset/getstreamfordataset/">DataSet:GetStream</a>.
     </p>
+
+    <h4 id="example-c002">2. <a href="{{ app_url ~ 'index.php?page=meg002'}}">Query monitoring data with filters</a></h4>
+    <p>
+        Demonstrates how to query an organization's data based on specified filters and aggregations.
+    </p>
+    <p>
+        API method used:
+        <a target='_blank' href="https://developers.docusign.com/docs/monitor-api/reference/monitor/dataset/postwebquery/">DataSet:postWebQuery</a>.
+    </p>
 </div>
 
 <!-- anchor-js is only for the index page -->