Merge pull request #10 from complycube/rc/1.1.6

Rc/1.1.6

Author: hkvcc

.gitignore

@@ -14,6 +14,7 @@ coverage_html
 
 # PHPUnit
 .phpunit.cache
+.phpunit.result.cache
 
 # Build data
 /build/

VERSION

@@ -1 +1 @@
-1.1.5
+1.1.6

composer.json

@@ -20,7 +20,7 @@
         "php": ">=7.4",
         "caseyamcl/guzzle_retry_middleware": "^2.8.0",
         "guzzlehttp/guzzle": "^7.5.0",
-        "nesbot/carbon": "^2.72.6"
+        "nesbot/carbon": "^3.8.4"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.16.0",

composer.lock

@@ -14,8 +14,8 @@
 
 class ApiClient
 {
-    /** @var integer */
-    const VERSION = '1.1.5';
+    /** @var string */
+    const VERSION = '1.1.6';
 
     /** @var string ComplyCube API key from developer dashboard */
     private string $apiKey;
@@ -26,10 +26,16 @@ class ApiClient
     /** @var ClientInterface Guzzle Http Client used to make requests */
     public ?ClientInterface $httpClient;
 
-    public static function randomJitter($numRequests, $response): float
+    public static function randomJitter(int $numRequests, mixed $response): float
     {
-        return (float) rand(0, $numRequests ** 1.5);
+        if ($numRequests <= 0) {
+            return 0.0;
+        }
+        $max = (int) ceil($numRequests ** 1.5);
+        $max = max(1, $max);
+        return (float) random_int(0, $max);
     }
+
     /**
      * Create instance of ComplyCube API client
      *

lib/ApiClient.php

@@ -19,6 +19,7 @@
 use ComplyCube\Resources\TeamMemberApi;
 use ComplyCube\Resources\TokenApi;
 use ComplyCube\Resources\WebhookApi;
+use ComplyCube\Resources\WorkflowSessionApi;
 
 class ComplyCubeClient
 {
@@ -39,6 +40,7 @@ class ComplyCubeClient
     private ?FlowSessionApi $flowSessionApi;
     private ?CompanyApi $companyApi;
     private ?CustomListApi $customListApi;
+    private ?WorkflowSessionApi $workflowSessionApi;
 
     /**
      * Create a ComplyCubeClient API Client Instance for the provided
@@ -293,4 +295,17 @@ public function customLists(): CustomListApi
         }
         return $this->customListApi;
     }
+
+    /**
+     * The workflow sessions API allows you to run and retrieve workflow sessions. You can retrieve a specific workflow sessions as well as a list of all your client's workflow sessions.
+     *
+     * @return WorkflowSessionApi
+     */
+    public function workflowSessions(): WorkflowSessionApi
+    {
+        if (empty($this->workflowSessionApi)) {
+            $this->workflowSessionApi = new WorkflowSessionApi($this->apiClient);
+        }
+        return $this->workflowSessionApi;
+    }
 }

lib/ComplyCubeClient.php

@@ -3,15 +3,16 @@
 namespace ComplyCube\Model;
 
 use Iterator;
+use Countable;
 use stdClass;
 
-class ComplyCubeCollection extends Model implements Iterator
+class ComplyCubeCollection extends Model implements Iterator, Countable
 {
     public int $page;
     public int $pageSize;
     public int $totalItems;
     public int $pages;
-    public ?array $items;
+    public ?array $items = null;
     private int $position;
     private string $model;
 
@@ -38,7 +39,8 @@ public function load(stdClass $response): void
             ? $response->pages
             : 0;
 
-        if (property_exists($response, "items")) {
+        if (property_exists($response, "items") && is_iterable($response->items)) {
+            $this->items = [];
             foreach ($response->items as $item) {
                 $this->items[] = new $this->model($item);
             }
@@ -49,6 +51,11 @@ public function load(stdClass $response): void
         $this->rewind();
     }
 
+    public function count(): int
+    {
+        return is_array($this->items) ? count($this->items) : 0;
+    }
+
     public function jsonSerialize(): mixed
     {
         return array_filter(

lib/Model/ComplyCubeCollection.php

@@ -8,12 +8,14 @@ class FlowSession extends Model
 {
     public ?string $clientId;
     public ?array $checkTypes;
+    public ?string $workflowTemplateId;
     public ?string $successUrl;
     public ?string $cancelUrl;
     public ?bool $enableMonitoring;
     public ?string $language;
     public ?string $theme;
     public ?string $redirectUrl;
+    public ?bool $shortUrl;
 
     public function load(stdClass $response): void
     {

lib/Model/FlowSession.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace ComplyCube\Model;
+
+use stdClass;
+
+class WorkflowSession extends Model
+{
+    public ?string $id;
+    public ?string $clientId;
+    public ?string $entityName;
+    public ?string $status;
+    public ?bool $workflowTemplateId;
+    public ?string $workflowTemplateName;
+    public ?string $workflowTemplateDescription;
+    public ?string $workflowId;
+    public ?int $workflowVersion;
+    public ?string $workflowDescription;
+    public ?array $compliancePolicies;
+    public ?string $outcome;
+    public ?array $allRelatedChecks;
+    public ?array $policyAssurance;
+    public ?array $tasks;
+    public ?string $lastCompletedTaskId;
+    public ?string $createdAt;
+    public ?string $completedAt;
+    public ?string $updatedAt;
+                        
+    public function load(stdClass $response): void
+    {
+        parent::load($response);
+    }
+}

lib/Model/WorkflowSession.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace ComplyCube\Resources;
+
+use ComplyCube\ApiClient;
+use ComplyCube\ApiResource;
+use ComplyCube\ResourceActions\GetResource;
+use ComplyCube\ResourceActions\ListResource;
+
+class WorkflowSessionApi extends ApiResource
+{
+    const ENDPOINT = "workflowSessions";
+
+    use GetResource,
+        ListResource;
+
+    public function __construct(ApiClient $apiClient)
+    {
+        parent::__construct($apiClient, "\ComplyCube\Model\WorkflowSession");
+    }
+
+    /**
+     * Complete the workflow session.
+     *
+     * @param string $workflowSessionId being completed.
+     */
+    public function complete(string $workflowSessionId)
+    {
+        $response = $this->apiClient->post(
+            $this::ENDPOINT . "/" . $workflowSessionId . "/complete",
+            []
+        );
+        return $response;
+    }
+}