remove site_url field in SE management (docs and code)

CHANGELOG.md

@@ -3,6 +3,9 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+## [7.0.4] - 2023-02-08
+### Changed
+- site_url field is now deprecated for search engine management
 
 ## [7.0.3] - 2022-11-21
 ### Changed

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "doofinder/php-doofinder",
-  "version": "7.0.3",
+  "version": "7.0.4",
   "type": "library",
   "description": "Doofinder PHP API Client",
   "keywords": [

doc/classes/Doofinder-Management-ManagementClient.html

@@ -1096,7 +1096,6 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
 'currency' =&gt; string, // Default: &quot;EUR&quot; (&quot;AED&quot;, &quot;ARS&quot;, &quot;AUD&quot;, &quot;BAM&quot;, &quot;BDT&quot;, &quot;BGN&quot;, &quot;BOB&quot;, &quot;BRL&quot;, &quot;BYN&quot;, &quot;CAD&quot;, &quot;CHF&quot;, &quot;CLP&quot;, &quot;CNY&quot;, &quot;COP&quot;, &quot;CZK&quot;, &quot;DKK&quot;, &quot;DOP&quot;, &quot;EGP&quot;, &quot;EUR&quot;, &quot;GBP&quot;, &quot;HKD&quot;, &quot;HRK&quot;, &quot;HUF&quot;, &quot;IDR&quot;, &quot;ILS&quot;, &quot;INR&quot;, &quot;IRR&quot;, &quot;ISK&quot;, &quot;JPY&quot;, &quot;KRW&quot;, &quot;KWD&quot;, &quot;MXN&quot;, &quot;MYR&quot;, &quot;NOK&quot;, &quot;NZD&quot;, &quot;PEN&quot;, &quot;PLN&quot;, &quot;RON&quot;, &quot;RSD&quot;, &quot;RUB&quot;, &quot;SAR&quot;, &quot;SEK&quot;, &quot;TRY&quot;, &quot;TWD&quot;, &quot;UAH&quot;, &quot;USD&quot;, &quot;VEF&quot;, &quot;VND&quot;, &quot;XPF&quot;, &quot;ZAR&quot;)
 'language' =&gt; string, // (&quot;ar&quot;, &quot;hy&quot;, &quot;eu&quot;, &quot;pt-br&quot;, &quot;bg&quot;, &quot;ca&quot;, &quot;cs&quot;, &quot;da&quot;, &quot;nl&quot;, &quot;en&quot;, &quot;fi&quot;, &quot;fr&quot;, &quot;de&quot;, &quot;el&quot;, &quot;hi&quot;, &quot;hu&quot;, &quot;id&quot;, &quot;it&quot;, &quot;no&quot;, &quot;pt&quot;, &quot;ro&quot;, &quot;ru&quot;, &quot;es&quot;, &quot;sv&quot;, &quot;tr&quot;),
 'name' =&gt; string,
-'site_url' =&gt; string|null,
 'stopwords' =&gt; boolean Default: false,
 'platform' =&gt; string, // Default: (&quot;api&quot;, &quot;api&quot;, &quot;shopify&quot;, &quot;woocommerce&quot;, &quot;bigcommerce&quot;, &quot;crawler&quot;, &quot;ecommerce&quot;, &quot;ekm&quot;, &quot;file&quot;, &quot;magento&quot;, &quot;magento2&quot;, &quot;opencart&quot;, &quot;oscommerce&quot;, &quot;prestashop&quot;, &quot;shopify&quot;),
 'has_grouping' =&gt; boolean, // Default: false
@@ -1121,7 +1120,6 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
 'currency' =&gt; string,
 'language' =&gt; string,
 'name' =&gt; string,
-'site_url' =&gt; string|null,
 'stopwords' =&gt; boolean Default: false,
 'platform' =&gt; string,
 'has_grouping' =&gt; boolean,

doc/classes/Doofinder-Management-Model-SearchEngine.html

@@ -210,13 +210,6 @@ <h3 id="toc">
     <span>
                 &nbsp;: string            </span>
 </dt>
-<dd></dd>
-
-            <dt class="phpdocumentor-table-of-contents__entry -property -private">
-    <a href="classes/Doofinder-Management-Model-SearchEngine.html#property_siteUrl">$siteUrl</a>
-    <span>
-                &nbsp;: string|null            </span>
-</dt>
 <dd></dd>
 
             <dt class="phpdocumentor-table-of-contents__entry -property -private">
@@ -280,13 +273,6 @@ <h3 id="toc">
     <span>
                         &nbsp;: string    </span>
 </dt>
-<dd></dd>
-
-            <dt class="phpdocumentor-table-of-contents__entry -method -public">
-    <a href="classes/Doofinder-Management-Model-SearchEngine.html#method_getSiteUrl">getSiteUrl()</a>
-    <span>
-                        &nbsp;: string|null    </span>
-</dt>
 <dd></dd>
 
             <dt class="phpdocumentor-table-of-contents__entry -method -public">
@@ -624,38 +610,7 @@ <h4 class="phpdocumentor-element__name" id="property_searchUrl">
 
 
 </article>
-                    <article
-        class="
-            phpdocumentor-element
-            -property
-            -private
-                                                        "
->
-    <h4 class="phpdocumentor-element__name" id="property_siteUrl">
-        $siteUrl
-        <a href="classes/Doofinder-Management-Model-SearchEngine.html#property_siteUrl" class="headerlink"><i class="fas fa-link"></i></a>
-        <span class="phpdocumentor-element__modifiers">
-                                </span>
-    </h4>
-    <aside class="phpdocumentor-element-found-in">
-    <abbr class="phpdocumentor-element-found-in__file" title="src/Management/Model/SearchEngine.php"><a href="files/src-management-model-searchengine.html"><abbr title="src/Management/Model/SearchEngine.php">SearchEngine.php</abbr></a></abbr>
-    :
-    <span class="phpdocumentor-element-found-in__line">50</span>
-
-    </aside>
 
-
-    <code class="phpdocumentor-code phpdocumentor-signature ">
-    <span class="phpdocumentor-signature__visibility">private</span>
-        <span class="phpdocumentor-signature__type">string|null</span>
-    <span class="phpdocumentor-signature__name">$siteUrl</span>
-    </code>
-
-
-
-
-
-</article>
                     <article
         class="
             phpdocumentor-element
@@ -960,38 +915,6 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
             &mdash;
 
 
-</article>
-                    <article
-        class="phpdocumentor-element
-            -method
-            -public
-                                                        "
->
-    <h4 class="phpdocumentor-element__name" id="method_getSiteUrl">
-        getSiteUrl()
-        <a href="classes/Doofinder-Management-Model-SearchEngine.html#method_getSiteUrl" class="headerlink"><i class="fas fa-link"></i></a>
-    </h4>
-    <aside class="phpdocumentor-element-found-in">
-    <abbr class="phpdocumentor-element-found-in__file" title="src/Management/Model/SearchEngine.php"><a href="files/src-management-model-searchengine.html"><abbr title="src/Management/Model/SearchEngine.php">SearchEngine.php</abbr></a></abbr>
-    :
-    <span class="phpdocumentor-element-found-in__line">173</span>
-
-    </aside>
-
-
-    <code class="phpdocumentor-code phpdocumentor-signature ">
-    <span class="phpdocumentor-signature__visibility">public</span>
-                <span class="phpdocumentor-signature__name">getSiteUrl</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|null</span></code>
-
-
-
-
-
-        <h5 class="phpdocumentor-return-value__heading">Return values</h5>
-    <span class="phpdocumentor-signature__response_type">string|null</span>
-            &mdash;
-
-
 </article>
                     <article
         class="phpdocumentor-element
@@ -1141,7 +1064,7 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">private</span>
-                <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$language</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$currency</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$hashid</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$indices</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$inactive</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$searchUrl</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$siteUrl</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$stopwords</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$platform</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$hasGrouping</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
+                <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$language</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$currency</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$hashid</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$indices</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$inactive</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$searchUrl</span></span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$stopwords</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$platform</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$hasGrouping</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
 
         <section class="phpdocumentor-description"></section>
 
@@ -1202,11 +1125,6 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
             <dd class="phpdocumentor-argument-list__definition">
                     <section class="phpdocumentor-description"></section>
 
-            </dd>
-                    <dt class="phpdocumentor-argument-list__entry">
-                <span class="phpdocumentor-signature__argument__name">$siteUrl</span>
-                : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
-                            </dt>
             <dd class="phpdocumentor-argument-list__definition">
                     <section class="phpdocumentor-description"></section>
 

doc/js/searchIndex.js

@@ -635,11 +635,6 @@ Search.appendIndex(
             "name": "getSearchUrl",
             "summary": "",
             "url": "classes/Doofinder-Management-Model-SearchEngine.html#method_getSearchUrl"
-        },                {
-            "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003AgetSiteUrl\u0028\u0029",
-            "name": "getSiteUrl",
-            "summary": "",
-            "url": "classes/Doofinder-Management-Model-SearchEngine.html#method_getSiteUrl"
         },                {
             "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003AisStopwords\u0028\u0029",
             "name": "isStopwords",
@@ -695,11 +690,6 @@ Search.appendIndex(
             "name": "searchUrl",
             "summary": "",
             "url": "classes/Doofinder-Management-Model-SearchEngine.html#property_searchUrl"
-        },                {
-            "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003A\u0024siteUrl",
-            "name": "siteUrl",
-            "summary": "",
-            "url": "classes/Doofinder-Management-Model-SearchEngine.html#property_siteUrl"
         },                {
             "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003A\u0024stopwords",
             "name": "stopwords",

src/Management/ManagementClient.php

@@ -67,7 +67,6 @@ public static function create($host, $token, $userId)
      *  'currency' => string,
      *  'language' => string,
      *  'name' => string,
-     *  'site_url' => string|null,
      *  'stopwords' => boolean Default: false,
      *  'platform' => string,
      *  'has_grouping' => boolean,
@@ -77,7 +76,6 @@ public static function create($host, $token, $userId)
      *  'currency' => string, // Default: "EUR" ("AED", "ARS", "AUD", "BAM", "BDT", "BGN", "BOB", "BRL", "BYN", "CAD", "CHF", "CLP", "CNY", "COP", "CZK", "DKK", "DOP", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "IRR", "ISK", "JPY", "KRW", "KWD", "MXN", "MYR", "NOK", "NZD", "PEN", "PLN", "RON", "RSD", "RUB", "SAR", "SEK", "TRY", "TWD", "UAH", "USD", "VEF", "VND", "XPF", "ZAR")
      *  'language' => string, // ("ar", "hy", "eu", "pt-br", "bg", "ca", "cs", "da", "nl", "en", "fi", "fr", "de", "el", "hi", "hu", "id", "it", "no", "pt", "ro", "ru", "es", "sv", "tr"),
      *  'name' => string,
-     *  'site_url' => string|null,
      *  'stopwords' => boolean Default: false,
      *  'platform' => string, // Default: ("api", "api", "shopify", "woocommerce", "bigcommerce", "crawler", "ecommerce", "ekm", "file", "magento", "magento2", "opencart", "oscommerce", "prestashop", "shopify"),
      *  'has_grouping' => boolean, // Default: false

src/Management/Model/SearchEngine.php

@@ -44,11 +44,6 @@ class SearchEngine implements ModelInterface
      */
     private $searchUrl;
 
-    /**
-     * @var string|null
-     */
-    private $siteUrl;
-
     /**
      * @var bool
      */
@@ -72,7 +67,6 @@ private function __construct(
         $indices,
         $inactive,
         $searchUrl,
-        $siteUrl,
         $stopwords,
         $platform,
         $hasGrouping
@@ -84,7 +78,6 @@ private function __construct(
         $this->indices = $indices;
         $this->inactive = $inactive;
         $this->searchUrl = $searchUrl;
-        $this->siteUrl = $siteUrl;
         $this->stopwords = $stopwords;
         $this->platform = $platform;
         $this->hasGrouping = $hasGrouping;
@@ -104,7 +97,6 @@ public static function createFromArray(array $data)
             $data['indices'],
             $data['inactive'],
             $data['search_url'],
-            $data['site_url'],
             $data['stopwords'],
             $data['platform'],
             $data['has_grouping']
@@ -167,14 +159,6 @@ public function getSearchUrl()
         return $this->searchUrl;
     }
 
-    /**
-     * @return string|null
-     */
-    public function getSiteUrl()
-    {
-        return $this->siteUrl;
-    }
-
     /**
      * @return bool
      */
@@ -212,7 +196,6 @@ public function jsonSerialize()
             'indices' => $this->indices,
             'inactive' => $this->inactive,
             'search_url' => $this->searchUrl,
-            'site_url' => $this->siteUrl,
             'stopwords' => $this->stopwords,
             'platform' => $this->platform,
             'has_grouping' => $this->hasGrouping