docs(overrides-synonyms): add phpdoc for legacy collection-scoped override and synonym methods

Author: tharropoulos

src/Override.php

@@ -58,6 +58,13 @@ private function endPointPath(): string
     }
 
     /**
+     * Retrieve an override (curation rule) by ID on this collection.
+     *
+     * @example
+     * $client->collections['products']->overrides['promote-hat']->retrieve()
+     *
+     * @see https://typesense.org/docs/latest/api/curation.html
+     *
      * @return array
      * @throws TypesenseClientError|HttpClientException
      */
@@ -67,6 +74,13 @@ public function retrieve(): array
     }
 
     /**
+     * Delete an override (curation rule) by ID on this collection.
+     *
+     * @example
+     * $client->collections['products']->overrides['promote-hat']->delete()
+     *
+     * @see https://typesense.org/docs/latest/api/curation.html
+     *
      * @return array
      * @throws TypesenseClientError|HttpClientException
      */

src/Overrides.php

@@ -60,6 +60,13 @@ public function endPointPath(string $overrideId = ''): string
     }
 
     /**
+     * Create or update an override (curation rule) on this collection.
+     *
+     * @example
+     * $client->collections['products']->overrides->upsert('promote-hat', ['rule' => ['query' => 'hat', 'match' => 'exact'], 'includes' => []])
+     *
+     * @see https://typesense.org/docs/latest/api/curation.html
+     *
      * @param string $overrideId
      * @param array $config
      *
@@ -72,6 +79,13 @@ public function upsert(string $overrideId, array $config): array
     }
 
     /**
+     * Retrieve all overrides (curation rules) on this collection.
+     *
+     * @example
+     * $client->collections['products']->overrides->retrieve()
+     *
+     * @see https://typesense.org/docs/latest/api/curation.html
+     *
      * @return array
      * @throws TypesenseClientError|HttpClientException
      */

src/Synonym.php

@@ -9,6 +9,8 @@
  * Class synonym
  *
  * @package \Typesense
+ *
+ * @deprecated Deprecated starting with Typesense Server v30. Please migrate to `$client->synonymSets` (new Synonym Sets APIs).
  */
 class Synonym
 {
@@ -56,6 +58,15 @@ private function endPointPath(): string
     }
 
     /**
+     * Retrieve a synonym (legacy v1) by ID on this collection.
+     *
+     * @example
+     * $client->collections['products']->synonyms['syn-1']->retrieve()
+     *
+     * @see https://typesense.org/docs/29.0/api/synonyms.html
+     *
+     * @deprecated Deprecated starting with Typesense Server v30. Please migrate to `$client->synonymSets` (new Synonym Sets APIs).
+     *
      * @return array
      * @throws TypesenseClientError|HttpClientException
      */
@@ -65,6 +76,15 @@ public function retrieve(): array
     }
 
     /**
+     * Delete a synonym (legacy v1) by ID on this collection.
+     *
+     * @example
+     * $client->collections['products']->synonyms['syn-1']->delete()
+     *
+     * @see https://typesense.org/docs/29.0/api/synonyms.html
+     *
+     * @deprecated Deprecated starting with Typesense Server v30. Please migrate to `$client->synonymSets` (new Synonym Sets APIs).
+     *
      * @return array
      * @throws TypesenseClientError|HttpClientException
      */

src/Synonyms.php

@@ -9,6 +9,8 @@
  * Class Synonyms
  *
  * @package \Typesense
+ *
+ * @deprecated Deprecated starting with Typesense Server v30. Please migrate to `$client->synonymSets` (new Synonym Sets APIs).
  */
 class Synonyms implements \ArrayAccess
 {
@@ -58,6 +60,15 @@ public function endPointPath(string $synonymId = ''): string
     }
 
     /**
+     * Create or update a synonym (legacy v1) on this collection.
+     *
+     * @example
+     * $client->collections['products']->synonyms->upsert('syn-1', ['synonyms' => ['nyc', 'new york']])
+     *
+     * @see https://typesense.org/docs/29.0/api/synonyms.html
+     *
+     * @deprecated Deprecated starting with Typesense Server v30. Please migrate to `$client->synonymSets` (new Synonym Sets APIs).
+     *
      * @param string $synonymId
      * @param array $config
      *
@@ -70,6 +81,15 @@ public function upsert(string $synonymId, array $config): array
     }
 
     /**
+     * Retrieve all synonyms (legacy v1) on this collection.
+     *
+     * @example
+     * $client->collections['products']->synonyms->retrieve()
+     *
+     * @see https://typesense.org/docs/29.0/api/synonyms.html
+     *
+     * @deprecated Deprecated starting with Typesense Server v30. Please migrate to `$client->synonymSets` (new Synonym Sets APIs).
+     *
      * @return array
      * @throws TypesenseClientError|HttpClientException
      */