Analytics Rules

Author: karakhanyans

src/Analytics.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Typesense;
+
+class Analytics
+{
+    const RESOURCE_PATH = '/analytics';
+
+    private ApiCall $apiCall;
+
+    public function __construct(ApiCall $apiCall)
+    {
+        $this->apiCall = $apiCall;
+    }
+
+    public function rules()
+    {
+        if (!isset($this->rules)) {
+            $this->rules = new AnalyticsRules($this->apiCall);
+        }
+        return $this->rules;
+    }
+}

src/AnalyticsRule.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Typesense;
+
+class AnalyticsRule
+{
+    private $ruleName;
+    private ApiCall $apiCall;
+
+    public function __construct(string $ruleName, ApiCall $apiCall)
+    {
+        $this->ruleName = $ruleName;
+        $this->apiCall = $apiCall;
+    }
+
+    public function retrieve()
+    {
+        return $this->apiCall->get($this->endpointPath(), []);
+    }
+
+    public function delete()
+    {
+        return $this->apiCall->delete($this->endpointPath());
+    }
+
+    private function endpointPath()
+    {
+        return AnalyticsRules::RESOURCE_PATH . '/' . $this->ruleName;
+    }
+}

src/AnalyticsRules.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Typesense;
+
+class AnalyticsRules
+{
+    const RESOURCE_PATH = '/analytics/rules';
+
+    private ApiCall $apiCall;
+    private $analyticsRules = [];
+
+    public function __construct(ApiCall $apiCall)
+    {
+        $this->apiCall = $apiCall;
+    }
+
+    public function __get($ruleName)
+    {
+        if (!isset($this->analyticsRules[$ruleName])) {
+            $this->analyticsRules[$ruleName] = new AnalyticsRule($ruleName, $this->apiCall);
+        }
+        return $this->analyticsRules[$ruleName];
+    }
+
+    public function upsert($ruleName, $params)
+    {
+        return $this->apiCall->put($this->endpoint_path($ruleName), $params);
+    }
+
+    public function retrieve()
+    {
+        return $this->apiCall->get($this->endpoint_path(), []);
+    }
+
+    private function endpoint_path($operation = null)
+    {
+        return self::RESOURCE_PATH . ($operation === null ? '' : "/$operation");
+    }
+}

src/Client.php

@@ -64,6 +64,11 @@ class Client
      */
     public Presets $presets;
 
+    /**
+     * @var Analytics
+     */
+    public Analytics $analytics;
+
     /**
      * @var ApiCall
      */
@@ -90,6 +95,7 @@ public function __construct(array $config)
         $this->operations  = new Operations($this->apiCall);
         $this->multiSearch = new MultiSearch($this->apiCall);
         $this->presets     = new Presets($this->apiCall);
+        $this->analytics   = new Analytics($this->apiCall);
     }
 
     /**
@@ -163,4 +169,12 @@ public function getPresets(): Presets
     {
         return $this->presets;
     }
+
+    /**
+     * @return Analytics
+     */
+    public function getAnalytics(): Analytics
+    {
+        return $this->analytics;
+    }
 }

src/Presets.php

@@ -17,7 +17,7 @@ class Presets
     /**
      * @var ApiCall
      */
-    private ApiCall $apiCall;
+    private $apiCall;
 
     public const PRESETS_PATH = '/presets';
 
@@ -39,7 +39,7 @@ public function __construct(ApiCall $apiCall)
      * @throws HttpClientException
      * @throws TypesenseClientError
      */
-    public function searchWithPreset($presetName): array|string
+    public function searchWithPreset($presetName)
     {
         return $this->apiCall->post($this->multiSearchEndpointPath(), [], true, ['preset' => $presetName]);
     }
@@ -49,7 +49,7 @@ public function searchWithPreset($presetName): array|string
      * @throws HttpClientException
      * @throws TypesenseClientError
      */
-    public function get(): array|string
+    public function get()
     {
         return $this->apiCall->get(static::PRESETS_PATH, []);
     }
@@ -61,10 +61,11 @@ public function get(): array|string
      * @throws HttpClientException
      * @throws TypesenseClientError
      */
-    public function put(array $options = []): array
+    public function put(array $options = [])
     {
         $presetName = $options['preset_name'];
         $presetsData = $options['preset_data'];
+
         return $this->apiCall->put($this->endpointPath($presetName), $presetsData);
     }
 
@@ -74,7 +75,7 @@ public function put(array $options = []): array
      * @throws HttpClientException
      * @throws TypesenseClientError
      */
-    public function delete($presetName): array
+    public function delete($presetName)
     {
         return $this->apiCall->delete($this->endpointPath($presetName));
     }
@@ -83,7 +84,7 @@ public function delete($presetName): array
      * @param $presetsName
      * @return string
      */
-    private function endpointPath($presetsName): string
+    private function endpointPath($presetsName)
     {
         return sprintf(
             '%s/%s',
@@ -96,7 +97,7 @@ private function endpointPath($presetsName): string
      * @param $presetsName
      * @return string
      */
-    private function multiSearchEndpointPath(): string
+    private function multiSearchEndpointPath()
     {
         return sprintf(
             '%s',