docs(curation-sets): add phpdoc for curation set class methods

Author: tharropoulos

src/CurationSet.php

@@ -67,6 +67,13 @@ private function endPointPath(): string
     }
 
     /**
+     * Create or update a curation set with the given name.
+     *
+     * @example
+     * $client->curationSets['my-set']->upsert(['items' => [['id' => 'promote-hat', 'rule' => ['query' => 'hat', 'match' => 'exact']]]])
+     *
+     * @see https://typesense.org/docs/latest/api/curation.html
+     *
      * @param array $params
      *
      * @return array
@@ -78,6 +85,13 @@ public function upsert(array $params): array
     }
 
     /**
+     * Retrieve a specific curation set by its name.
+     *
+     * @example
+     * $client->curationSets['my-set']->retrieve()
+     *
+     * @see https://typesense.org/docs/latest/api/curation.html
+     *
      * @return array
      * @throws TypesenseClientError|HttpClientException
      */
@@ -87,6 +101,13 @@ public function retrieve(): array
     }
 
     /**
+     * Delete a specific curation set by its name.
+     *
+     * @example
+     * $client->curationSets['my-set']->delete()
+     *
+     * @see https://typesense.org/docs/latest/api/curation.html
+     *
      * @return array
      * @throws TypesenseClientError|HttpClientException
      */
@@ -96,6 +117,16 @@ public function delete(): array
     }
 
     /**
+     * Access the items in this curation set. Use the returned object as an array to access
+     * a single item by ID, or call `retrieve()` to list all items.
+     *
+     * @example
+     * $client->curationSets['my-set']->getItems()->retrieve()
+     * @example
+     * $client->curationSets['my-set']->getItems()['promote-hat']->retrieve()
+     *
+     * @see https://typesense.org/docs/latest/api/curation.html
+     *
      * @return CurationSetItems
      */
     public function getItems(): CurationSetItems

src/CurationSetItem.php

@@ -55,6 +55,13 @@ private function endPointPath(): string
     }
 
     /**
+     * Retrieve a specific curation item by its id.
+     *
+     * @example
+     * $client->curationSets['my-set']->getItems()['promote-hat']->retrieve()
+     *
+     * @see https://typesense.org/docs/latest/api/curation.html
+     *
      * @return array
      * @throws TypesenseClientError|HttpClientException
      */
@@ -64,6 +71,13 @@ public function retrieve(): array
     }
 
     /**
+     * Create or update a curation set item with the given id.
+     *
+     * @example
+     * $client->curationSets['my-set']->getItems()['promote-hat']->upsert(['rule' => ['query' => 'hat', 'match' => 'exact'], 'includes' => []])
+     *
+     * @see https://typesense.org/docs/latest/api/curation.html
+     *
      * @param array $params
      *
      * @return array
@@ -75,6 +89,13 @@ public function upsert(array $params): array
     }
 
     /**
+     * Delete a specific curation item by its id.
+     *
+     * @example
+     * $client->curationSets['my-set']->getItems()['promote-hat']->delete()
+     *
+     * @see https://typesense.org/docs/latest/api/curation.html
+     *
      * @return array
      * @throws TypesenseClientError|HttpClientException
      */

src/CurationSetItems.php

@@ -52,6 +52,13 @@ private function endPointPath(): string
     }
 
     /**
+     * Retrieve all curation items in a set.
+     *
+     * @example
+     * $client->curationSets['my-set']->getItems()->retrieve()
+     *
+     * @see https://typesense.org/docs/latest/api/curation.html
+     *
      * @return array
      * @throws TypesenseClientError|HttpClientException
      */

src/CurationSets.php

@@ -35,6 +35,13 @@ public function __construct(ApiCall $apiCall)
     }
 
     /**
+     * Create or update a curation set with the given name.
+     *
+     * @example
+     * $client->curationSets->upsert('my-set', ['items' => [['id' => 'promote-hat', 'rule' => ['query' => 'hat', 'match' => 'exact']]]])
+     *
+     * @see https://typesense.org/docs/latest/api/curation.html
+     *
      * @param string $curationSetName
      * @param array $config
      *
@@ -47,6 +54,13 @@ public function upsert(string $curationSetName, array $config): array
     }
 
     /**
+     * Retrieve all curation sets.
+     *
+     * @example
+     * $client->curationSets->retrieve()
+     *
+     * @see https://typesense.org/docs/latest/api/curation.html
+     *
      * @return array
      * @throws TypesenseClientError|HttpClientException
      */