feat(clients): more manual snippets for doc (generated)

algolia/api-clients-automation#4452

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Thomas Raffray <[email protected]>
Co-authored-by: shortcuts <[email protected]>

Author: 3 people

lib/Api/AbtestingClient.php

@@ -121,10 +121,10 @@ public function setClientApiKey($apiKey)
      * Required API Key ACLs:
      *  - editSettings
      *
-     * @param array $addABTestsRequest addABTestsRequest (required)
-     *                                 - $addABTestsRequest['name'] => (string) A/B test name. (required)
-     *                                 - $addABTestsRequest['variants'] => (array) A/B test variants. (required)
-     *                                 - $addABTestsRequest['endAt'] => (string) End date and time of the A/B test, in RFC 3339 format. (required)
+     * @param AddABTestsRequest|array $addABTestsRequest addABTestsRequest (required)
+     *                                                   - $addABTestsRequest['name'] => (string) A/B test name. (required)
+     *                                                   - $addABTestsRequest['variants'] => (array) A/B test variants. (required)
+     *                                                   - $addABTestsRequest['endAt'] => (string) End date and time of the A/B test, in RFC 3339 format. (required)
      *
      * @see AddABTestsRequest
      *
@@ -350,9 +350,9 @@ public function deleteABTest($id, $requestOptions = [])
      * Required API Key ACLs:
      *  - analytics
      *
-     * @param array $estimateABTestRequest estimateABTestRequest (required)
-     *                                     - $estimateABTestRequest['configuration'] => (array)  (required)
-     *                                     - $estimateABTestRequest['variants'] => (array) A/B test variants. (required)
+     * @param array|EstimateABTestRequest $estimateABTestRequest estimateABTestRequest (required)
+     *                                                           - $estimateABTestRequest['configuration'] => (array)  (required)
+     *                                                           - $estimateABTestRequest['variants'] => (array) A/B test variants. (required)
      *
      * @see EstimateABTestRequest
      *
@@ -460,11 +460,11 @@ public function listABTests($offset = null, $limit = null, $indexPrefix = null,
      * Required API Key ACLs:
      *  - editSettings
      *
-     * @param array $scheduleABTestsRequest scheduleABTestsRequest (required)
-     *                                      - $scheduleABTestsRequest['name'] => (string) A/B test name. (required)
-     *                                      - $scheduleABTestsRequest['variants'] => (array) A/B test variants. (required)
-     *                                      - $scheduleABTestsRequest['scheduledAt'] => (string) Date and time when the A/B test is scheduled to start, in RFC 3339 format. (required)
-     *                                      - $scheduleABTestsRequest['endAt'] => (string) End date and time of the A/B test, in RFC 3339 format. (required)
+     * @param array|ScheduleABTestsRequest $scheduleABTestsRequest scheduleABTestsRequest (required)
+     *                                                             - $scheduleABTestsRequest['name'] => (string) A/B test name. (required)
+     *                                                             - $scheduleABTestsRequest['variants'] => (array) A/B test variants. (required)
+     *                                                             - $scheduleABTestsRequest['scheduledAt'] => (string) Date and time when the A/B test is scheduled to start, in RFC 3339 format. (required)
+     *                                                             - $scheduleABTestsRequest['endAt'] => (string) End date and time of the A/B test, in RFC 3339 format. (required)
      *
      * @see ScheduleABTestsRequest
      *

lib/Api/CompositionClient.php

@@ -117,9 +117,9 @@ public function setClientApiKey($apiKey)
      * Required API Key ACLs:
      *  - search
      *
-     * @param string $compositionID Unique Composition ObjectID. (required)
-     * @param array  $requestBody   requestBody (required)
-     *                              - $requestBody['params'] => (array)
+     * @param string            $compositionID Unique Composition ObjectID. (required)
+     * @param array|RequestBody $requestBody   requestBody (required)
+     *                                         - $requestBody['params'] => (array)
      *
      * @see RequestBody
      *
@@ -165,10 +165,10 @@ public function search($compositionID, $requestBody, $requestOptions = [])
      * Required API Key ACLs:
      *  - search
      *
-     * @param string $compositionID               Unique Composition ObjectID. (required)
-     * @param string $facetName                   Facet attribute in which to search for values.  This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier. (required)
-     * @param array  $searchForFacetValuesRequest searchForFacetValuesRequest (optional)
-     *                                            - $searchForFacetValuesRequest['params'] => (array)
+     * @param string                            $compositionID               Unique Composition ObjectID. (required)
+     * @param string                            $facetName                   Facet attribute in which to search for values.  This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier. (required)
+     * @param array|SearchForFacetValuesRequest $searchForFacetValuesRequest searchForFacetValuesRequest (optional)
+     *                                                                       - $searchForFacetValuesRequest['params'] => (array)
      *
      * @see SearchForFacetValuesRequest
      *