Skip to content

Commit d896997

Browse files
algolia-botalgolia-bot
committed
chore(deps): dependencies 2024-10-14 (generated)
algolia/api-clients-automation#3944 Co-authored-by: algolia-bot <[email protected]>
1 parent b2f3fdb commit d896997

11 files changed

+352
-123
lines changed

‎lib/Api/AbtestingClient.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ public function addABTests($addABTestsRequest, $requestOptions = [])
146146
/**
147147
* This method allow you to send requests to the Algolia REST API.
148148
*
149-
* @param string $path Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
149+
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
150150
* @param array $parameters Query parameters to apply to the current query. (optional)
151151
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
152152
*
@@ -185,7 +185,7 @@ public function customDelete($path, $parameters = null, $requestOptions = [])
185185
/**
186186
* This method allow you to send requests to the Algolia REST API.
187187
*
188-
* @param string $path Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
188+
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
189189
* @param array $parameters Query parameters to apply to the current query. (optional)
190190
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
191191
*
@@ -224,7 +224,7 @@ public function customGet($path, $parameters = null, $requestOptions = [])
224224
/**
225225
* This method allow you to send requests to the Algolia REST API.
226226
*
227-
* @param string $path Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
227+
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
228228
* @param array $parameters Query parameters to apply to the current query. (optional)
229229
* @param array $body Parameters to send with the custom request. (optional)
230230
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
@@ -264,7 +264,7 @@ public function customPost($path, $parameters = null, $body = null, $requestOpti
264264
/**
265265
* This method allow you to send requests to the Algolia REST API.
266266
*
267-
* @param string $path Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
267+
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
268268
* @param array $parameters Query parameters to apply to the current query. (optional)
269269
* @param array $body Parameters to send with the custom request. (optional)
270270
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions

‎lib/Api/AnalyticsClient.php‎

Lines changed: 78 additions & 78 deletions
Large diffs are not rendered by default.

‎lib/Api/IngestionClient.php‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ public function createTransformation($transformationCreate, $requestOptions = []
345345
/**
346346
* This method allow you to send requests to the Algolia REST API.
347347
*
348-
* @param string $path Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
348+
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
349349
* @param array $parameters Query parameters to apply to the current query. (optional)
350350
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
351351
*
@@ -384,7 +384,7 @@ public function customDelete($path, $parameters = null, $requestOptions = [])
384384
/**
385385
* This method allow you to send requests to the Algolia REST API.
386386
*
387-
* @param string $path Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
387+
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
388388
* @param array $parameters Query parameters to apply to the current query. (optional)
389389
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
390390
*
@@ -423,7 +423,7 @@ public function customGet($path, $parameters = null, $requestOptions = [])
423423
/**
424424
* This method allow you to send requests to the Algolia REST API.
425425
*
426-
* @param string $path Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
426+
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
427427
* @param array $parameters Query parameters to apply to the current query. (optional)
428428
* @param array $body Parameters to send with the custom request. (optional)
429429
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
@@ -463,7 +463,7 @@ public function customPost($path, $parameters = null, $body = null, $requestOpti
463463
/**
464464
* This method allow you to send requests to the Algolia REST API.
465465
*
466-
* @param string $path Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
466+
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
467467
* @param array $parameters Query parameters to apply to the current query. (optional)
468468
* @param array $body Parameters to send with the custom request. (optional)
469469
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
@@ -1486,7 +1486,7 @@ public function listRuns($itemsPerPage = null, $page = null, $status = null, $ty
14861486
* @param int $itemsPerPage Number of items per page. (optional, default to 10)
14871487
* @param int $page Page number of the paginated API response. (optional)
14881488
* @param array $type Source type. Some sources require authentication. (optional)
1489-
* @param array $authenticationID Authentication IDs of the sources to retrieve. &#39;none&#39; returns sources that doesn&#39;t have an authentication. (optional)
1489+
* @param array $authenticationID Authentication IDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication. (optional)
14901490
* @param array $sort Property by which to sort the list of sources. (optional)
14911491
* @param array $order Sort order of the response, ascending or descending. (optional)
14921492
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
@@ -1544,7 +1544,7 @@ public function listSources($itemsPerPage = null, $page = null, $type = null, $a
15441544
* @param int $itemsPerPage Number of items per page. (optional, default to 10)
15451545
* @param int $page Page number of the paginated API response. (optional)
15461546
* @param array $action Actions for filtering the list of tasks. (optional)
1547-
* @param bool $enabled Whether to filter the list of tasks by the &#x60;enabled&#x60; status. (optional)
1547+
* @param bool $enabled Whether to filter the list of tasks by the `enabled` status. (optional)
15481548
* @param array $sourceID Source IDs for filtering the list of tasks. (optional)
15491549
* @param array $destinationID Destination IDs for filtering the list of tasks. (optional)
15501550
* @param array $triggerType Type of task trigger for filtering the list of tasks. (optional)
@@ -1623,7 +1623,7 @@ public function listTasks($itemsPerPage = null, $page = null, $action = null, $e
16231623
* @param int $itemsPerPage Number of items per page. (optional, default to 10)
16241624
* @param int $page Page number of the paginated API response. (optional)
16251625
* @param array $action Actions for filtering the list of tasks. (optional)
1626-
* @param bool $enabled Whether to filter the list of tasks by the &#x60;enabled&#x60; status. (optional)
1626+
* @param bool $enabled Whether to filter the list of tasks by the `enabled` status. (optional)
16271627
* @param array $sourceID Source IDs for filtering the list of tasks. (optional)
16281628
* @param array $destinationID Destination IDs for filtering the list of tasks. (optional)
16291629
* @param array $triggerType Type of task trigger for filtering the list of tasks. (optional)
@@ -1742,7 +1742,7 @@ public function listTransformations($itemsPerPage = null, $page = null, $sort =
17421742
* - editSettings
17431743
*
17441744
* @param string $taskID Unique identifier of a task. (required)
1745-
* @param array $pushTaskPayload Request body of a Search API &#x60;batch&#x60; request that will be pushed in the Connectors pipeline. (required)
1745+
* @param array $pushTaskPayload Request body of a Search API `batch` request that will be pushed in the Connectors pipeline. (required)
17461746
* - $pushTaskPayload['action'] => (array) (required)
17471747
* - $pushTaskPayload['records'] => (array) (required)
17481748
*

‎lib/Api/InsightsClient.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ public function setClientApiKey($apiKey)
111111
/**
112112
* This method allow you to send requests to the Algolia REST API.
113113
*
114-
* @param string $path Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
114+
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
115115
* @param array $parameters Query parameters to apply to the current query. (optional)
116116
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
117117
*
@@ -150,7 +150,7 @@ public function customDelete($path, $parameters = null, $requestOptions = [])
150150
/**
151151
* This method allow you to send requests to the Algolia REST API.
152152
*
153-
* @param string $path Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
153+
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
154154
* @param array $parameters Query parameters to apply to the current query. (optional)
155155
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
156156
*
@@ -189,7 +189,7 @@ public function customGet($path, $parameters = null, $requestOptions = [])
189189
/**
190190
* This method allow you to send requests to the Algolia REST API.
191191
*
192-
* @param string $path Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
192+
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
193193
* @param array $parameters Query parameters to apply to the current query. (optional)
194194
* @param array $body Parameters to send with the custom request. (optional)
195195
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
@@ -229,7 +229,7 @@ public function customPost($path, $parameters = null, $body = null, $requestOpti
229229
/**
230230
* This method allow you to send requests to the Algolia REST API.
231231
*
232-
* @param string $path Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
232+
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
233233
* @param array $parameters Query parameters to apply to the current query. (optional)
234234
* @param array $body Parameters to send with the custom request. (optional)
235235
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions

‎lib/Api/MonitoringClient.php‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ public function setClientApiKey($apiKey)
106106
/**
107107
* This method allow you to send requests to the Algolia REST API.
108108
*
109-
* @param string $path Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
109+
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
110110
* @param array $parameters Query parameters to apply to the current query. (optional)
111111
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
112112
*
@@ -145,7 +145,7 @@ public function customDelete($path, $parameters = null, $requestOptions = [])
145145
/**
146146
* This method allow you to send requests to the Algolia REST API.
147147
*
148-
* @param string $path Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
148+
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
149149
* @param array $parameters Query parameters to apply to the current query. (optional)
150150
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
151151
*
@@ -184,7 +184,7 @@ public function customGet($path, $parameters = null, $requestOptions = [])
184184
/**
185185
* This method allow you to send requests to the Algolia REST API.
186186
*
187-
* @param string $path Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
187+
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
188188
* @param array $parameters Query parameters to apply to the current query. (optional)
189189
* @param array $body Parameters to send with the custom request. (optional)
190190
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
@@ -224,7 +224,7 @@ public function customPost($path, $parameters = null, $body = null, $requestOpti
224224
/**
225225
* This method allow you to send requests to the Algolia REST API.
226226
*
227-
* @param string $path Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
227+
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
228228
* @param array $parameters Query parameters to apply to the current query. (optional)
229229
* @param array $body Parameters to send with the custom request. (optional)
230230
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
@@ -417,8 +417,8 @@ public function getLatency($clusters, $requestOptions = [])
417417
/**
418418
* Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window. Access to this API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing). You must authenticate requests with the `x-algolia-application-id` and `x-algolia-api-key` headers (using the Monitoring API key).
419419
*
420-
* @param array $metric Metric to report. For more information about the individual metrics, see the description of the API response. To include all metrics, use &#x60;*&#x60;. (required)
421-
* @param array $period Period over which to aggregate the metrics: - &#x60;minute&#x60;. Aggregate the last minute. 1 data point per 10 seconds. - &#x60;hour&#x60;. Aggregate the last hour. 1 data point per minute. - &#x60;day&#x60;. Aggregate the last day. 1 data point per 10 minutes. - &#x60;week&#x60;. Aggregate the last week. 1 data point per hour. - &#x60;month&#x60;. Aggregate the last month. 1 data point per day. (required)
420+
* @param array $metric Metric to report. For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`. (required)
421+
* @param array $period Period over which to aggregate the metrics: - `minute`. Aggregate the last minute. 1 data point per 10 seconds. - `hour`. Aggregate the last hour. 1 data point per minute. - `day`. Aggregate the last day. 1 data point per 10 minutes. - `week`. Aggregate the last week. 1 data point per hour. - `month`. Aggregate the last month. 1 data point per day. (required)
422422
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
423423
*
424424
* @return \Algolia\AlgoliaSearch\Model\Monitoring\InfrastructureResponse|array<string, mixed>

‎lib/Api/PersonalizationClient.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ public function setClientApiKey($apiKey)
111111
/**
112112
* This method allow you to send requests to the Algolia REST API.
113113
*
114-
* @param string $path Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
114+
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
115115
* @param array $parameters Query parameters to apply to the current query. (optional)
116116
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
117117
*
@@ -150,7 +150,7 @@ public function customDelete($path, $parameters = null, $requestOptions = [])
150150
/**
151151
* This method allow you to send requests to the Algolia REST API.
152152
*
153-
* @param string $path Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
153+
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
154154
* @param array $parameters Query parameters to apply to the current query. (optional)
155155
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
156156
*
@@ -189,7 +189,7 @@ public function customGet($path, $parameters = null, $requestOptions = [])
189189
/**
190190
* This method allow you to send requests to the Algolia REST API.
191191
*
192-
* @param string $path Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
192+
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
193193
* @param array $parameters Query parameters to apply to the current query. (optional)
194194
* @param array $body Parameters to send with the custom request. (optional)
195195
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
@@ -229,7 +229,7 @@ public function customPost($path, $parameters = null, $body = null, $requestOpti
229229
/**
230230
* This method allow you to send requests to the Algolia REST API.
231231
*
232-
* @param string $path Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
232+
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
233233
* @param array $parameters Query parameters to apply to the current query. (optional)
234234
* @param array $body Parameters to send with the custom request. (optional)
235235
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions

0 commit comments

Comments
 (0)