fix(clients): escape char in comments (generated)

algolia/api-clients-automation#3973 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
algolia · Oct 15, 2024 · 00305cb · 00305cb
1 parent d896997
commit 00305cb
Show file tree

Hide file tree

Showing 70 changed files with 70 additions and 70 deletions.
diff --git a/lib/Model/Abtesting/Status.php b/lib/Model/Abtesting/Status.php
@@ -9,7 +9,7 @@
  *
  * @category Class
  *
- * @description A/B test status.  - &#x60;active&#x60;. The A/B test is live and search traffic is split between the two variants. - &#x60;stopped&#x60;. You stopped the A/B test. The A/B test data is still available for analysis. - &#x60;expired&#x60;. The A/B test was automatically stopped after reaching its end date. - &#x60;failed&#x60;. Creating the A/B test failed.
+ * @description A/B test status.  - `active`. The A/B test is live and search traffic is split between the two variants. - `stopped`. You stopped the A/B test. The A/B test data is still available for analysis. - `expired`. The A/B test was automatically stopped after reaching its end date. - `failed`. Creating the A/B test failed.
  */
 class Status
 {

diff --git a/lib/Model/Analytics/Operator.php b/lib/Model/Analytics/Operator.php
@@ -9,7 +9,7 @@
  *
  * @category Class
  *
- * @description Character that characterizes how the filter is applied.  For example, for a facet filter &#x60;facet:value&#x60;, &#x60;:&#x60; is the operator. For a numeric filter &#x60;count&gt;50&#x60;, &#x60;&gt;&#x60; is the operator.
+ * @description Character that characterizes how the filter is applied.  For example, for a facet filter `facet:value`, `:` is the operator. For a numeric filter `count>50`, `>` is the operator.
  */
 class Operator
 {

diff --git a/lib/Model/Analytics/OrderBy.php b/lib/Model/Analytics/OrderBy.php
@@ -9,7 +9,7 @@
  *
  * @category Class
  *
- * @description Attribute by which to order the response items.  If the &#x60;clickAnalytics&#x60; parameter is false, only &#x60;searchCount&#x60; is available.
+ * @description Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
  */
 class OrderBy
 {

diff --git a/lib/Model/Ingestion/AuthenticationType.php b/lib/Model/Ingestion/AuthenticationType.php
@@ -9,7 +9,7 @@
  *
  * @category Class
  *
- * @description Type of authentication. This determines the type of credentials required in the &#x60;input&#x60; object.
+ * @description Type of authentication. This determines the type of credentials required in the `input` object.
  */
 class AuthenticationType
 {

diff --git a/lib/Model/Ingestion/DestinationType.php b/lib/Model/Ingestion/DestinationType.php
@@ -9,7 +9,7 @@
  *
  * @category Class
  *
- * @description Destination type.  - &#x60;search&#x60;.   Data is stored in an Algolia index.  - &#x60;insights&#x60;.   Data is recorded as user events in the Insights API.
+ * @description Destination type.  - `search`.   Data is stored in an Algolia index.  - `insights`.   Data is recorded as user events in the Insights API.
  */
 class DestinationType
 {

diff --git a/lib/Model/Ingestion/OnDemandTriggerType.php b/lib/Model/Ingestion/OnDemandTriggerType.php
@@ -9,7 +9,7 @@
  *
  * @category Class
  *
- * @description Task is run manually, with the &#x60;/run&#x60; endpoint.
+ * @description Task is run manually, with the `/run` endpoint.
  */
 class OnDemandTriggerType
 {

diff --git a/lib/Model/Ingestion/RunReasonCode.php b/lib/Model/Ingestion/RunReasonCode.php
@@ -9,7 +9,7 @@
  *
  * @category Class
  *
- * @description A code for the task run&#39;s outcome. A readable description of the code is included in the &#x60;reason&#x60; response property.
+ * @description A code for the task run's outcome. A readable description of the code is included in the `reason` response property.
  */
 class RunReasonCode
 {

diff --git a/lib/Model/Ingestion/ShopifyInput.php b/lib/Model/Ingestion/ShopifyInput.php
@@ -12,7 +12,7 @@
  *
  * @category Class
  *
- * @description Represents the required elements of the task input when using a &#x60;shopify&#x60; source.
+ * @description Represents the required elements of the task input when using a `shopify` source.
  */
 class ShopifyInput extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {

diff --git a/lib/Model/Ingestion/StreamingInput.php b/lib/Model/Ingestion/StreamingInput.php
@@ -12,7 +12,7 @@
  *
  * @category Class
  *
- * @description Input for a &#x60;streaming&#x60; task whose source is of type &#x60;ga4BigqueryExport&#x60; and for which extracted data is continuously streamed.
+ * @description Input for a `streaming` task whose source is of type `ga4BigqueryExport` and for which extracted data is continuously streamed.
  */
 class StreamingInput extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {

diff --git a/lib/Model/Ingestion/TaskCreateV1.php b/lib/Model/Ingestion/TaskCreateV1.php
@@ -12,7 +12,7 @@
  *
  * @category Class
  *
- * @description API request body for creating a task using the V1 shape, please use methods and types that don&#39;t contain the V1 suffix.
+ * @description API request body for creating a task using the V1 shape, please use methods and types that don't contain the V1 suffix.
  */
 class TaskCreateV1 extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {

diff --git a/lib/Model/Ingestion/TaskUpdateV1.php b/lib/Model/Ingestion/TaskUpdateV1.php
@@ -12,7 +12,7 @@
  *
  * @category Class
  *
- * @description API request body for updating a task using the V1 shape, please use methods and types that don&#39;t contain the V1 suffix.
+ * @description API request body for updating a task using the V1 shape, please use methods and types that don't contain the V1 suffix.
  */
 class TaskUpdateV1 extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {

diff --git a/lib/Model/Ingestion/TaskV1.php b/lib/Model/Ingestion/TaskV1.php
@@ -12,7 +12,7 @@
  *
  * @category Class
  *
- * @description The V1 task object, please use methods and types that don&#39;t contain the V1 suffix.
+ * @description The V1 task object, please use methods and types that don't contain the V1 suffix.
  */
 class TaskV1 extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {

diff --git a/lib/Model/Ingestion/TriggerType.php b/lib/Model/Ingestion/TriggerType.php
@@ -9,7 +9,7 @@
  *
  * @category Class
  *
- * @description Task trigger, describing when a task should run.  - &#x60;onDemand&#x60;.   Manually trigger the task with the &#x60;/run&#x60; endpoint.  - &#x60;schedule&#x60;.   Regularly trigger the task on a &#x60;cron&#x60; schedule.  - &#x60;subscription&#x60;.   Trigger the task after an event is received, such as, a webhook.  - &#x60;streaming&#x60;.   Run the task continuously.
+ * @description Task trigger, describing when a task should run.  - `onDemand`.   Manually trigger the task with the `/run` endpoint.  - `schedule`.   Regularly trigger the task on a `cron` schedule.  - `subscription`.   Trigger the task after an event is received, such as, a webhook.  - `streaming`.   Run the task continuously.
  */
 class TriggerType
 {

diff --git a/lib/Model/Insights/AddedToCartObjectIDs.php b/lib/Model/Insights/AddedToCartObjectIDs.php
@@ -12,7 +12,7 @@
  *
  * @category Class
  *
- * @description Use this event to track when users add items to their shopping cart unrelated to a previous Algolia request. For example, if you don&#39;t use Algolia to build your category pages, use this event.  To track add-to-cart events related to Algolia requests, use the \&quot;Added to cart object IDs after search\&quot; event.
+ * @description Use this event to track when users add items to their shopping cart unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event.  To track add-to-cart events related to Algolia requests, use the \"Added to cart object IDs after search\" event.
  */
 class AddedToCartObjectIDs extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {

diff --git a/lib/Model/Insights/AddedToCartObjectIDsAfterSearch.php b/lib/Model/Insights/AddedToCartObjectIDsAfterSearch.php
@@ -12,7 +12,7 @@
  *
  * @category Class
  *
- * @description Use this event to track when users add items to their shopping cart after a previous Algolia request. If you&#39;re building your category pages with Algolia, you&#39;ll also use this event.
+ * @description Use this event to track when users add items to their shopping cart after a previous Algolia request. If you're building your category pages with Algolia, you'll also use this event.
  */
 class AddedToCartObjectIDsAfterSearch extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {

diff --git a/lib/Model/Insights/ClickedObjectIDs.php b/lib/Model/Insights/ClickedObjectIDs.php
@@ -12,7 +12,7 @@
  *
  * @category Class
  *
- * @description Use this event to track when users click items unrelated to a previous Algolia request. For example, if you don&#39;t use Algolia to build your category pages, use this event.  To track click events related to Algolia requests, use the \&quot;Clicked object IDs after search\&quot; event.
+ * @description Use this event to track when users click items unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event.  To track click events related to Algolia requests, use the \"Clicked object IDs after search\" event.
  */
 class ClickedObjectIDs extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {

diff --git a/lib/Model/Insights/ClickedObjectIDsAfterSearch.php b/lib/Model/Insights/ClickedObjectIDsAfterSearch.php
@@ -12,7 +12,7 @@
  *
  * @category Class
  *
- * @description Click event after an Algolia request.  Use this event to track when users click items in the search results. If you&#39;re building your category pages with Algolia, you&#39;ll also use this event.
+ * @description Click event after an Algolia request.  Use this event to track when users click items in the search results. If you're building your category pages with Algolia, you'll also use this event.
  */
 class ClickedObjectIDsAfterSearch extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {

diff --git a/lib/Model/Insights/ConvertedObjectIDs.php b/lib/Model/Insights/ConvertedObjectIDs.php
@@ -12,7 +12,7 @@
  *
  * @category Class
  *
- * @description Use this event to track when users convert on items unrelated to a previous Algolia request. For example, if you don&#39;t use Algolia to build your category pages, use this event.  To track conversion events related to Algolia requests, use the \&quot;Converted object IDs after search\&quot; event.
+ * @description Use this event to track when users convert on items unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event.  To track conversion events related to Algolia requests, use the \"Converted object IDs after search\" event.
  */
 class ConvertedObjectIDs extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {

diff --git a/lib/Model/Insights/ConvertedObjectIDsAfterSearch.php b/lib/Model/Insights/ConvertedObjectIDsAfterSearch.php
@@ -12,7 +12,7 @@
  *
  * @category Class
  *
- * @description Use this event to track when users convert after a previous Algolia request. For example, a user clicks on an item in the search results to view the product detail page. Then, the user adds the item to their shopping cart.  If you&#39;re building your category pages with Algolia, you&#39;ll also use this event.
+ * @description Use this event to track when users convert after a previous Algolia request. For example, a user clicks on an item in the search results to view the product detail page. Then, the user adds the item to their shopping cart.  If you're building your category pages with Algolia, you'll also use this event.
  */
 class ConvertedObjectIDsAfterSearch extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {

diff --git a/lib/Model/Insights/Discount.php b/lib/Model/Insights/Discount.php
@@ -12,7 +12,7 @@
  *
  * @category Class
  *
- * @description Absolute value of the discount for this product, in units of &#x60;currency&#x60;.
+ * @description Absolute value of the discount for this product, in units of `currency`.
  */
 class Discount extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {

diff --git a/lib/Model/Insights/Price.php b/lib/Model/Insights/Price.php
@@ -12,7 +12,7 @@
  *
  * @category Class
  *
- * @description Total price of a product, including any discounts, in units of &#x60;currency&#x60;.
+ * @description Total price of a product, including any discounts, in units of `currency`.
  */
 class Price extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {

diff --git a/lib/Model/Insights/PurchasedObjectIDs.php b/lib/Model/Insights/PurchasedObjectIDs.php
@@ -12,7 +12,7 @@
  *
  * @category Class
  *
- * @description Use this event to track when users make a purchase unrelated to a previous Algolia request. For example, if you don&#39;t use Algolia to build your category pages, use this event.  To track purchase events related to Algolia requests, use the \&quot;Purchased object IDs after search\&quot; event.
+ * @description Use this event to track when users make a purchase unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event.  To track purchase events related to Algolia requests, use the \"Purchased object IDs after search\" event.
  */
 class PurchasedObjectIDs extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {

diff --git a/lib/Model/Insights/PurchasedObjectIDsAfterSearch.php b/lib/Model/Insights/PurchasedObjectIDsAfterSearch.php
@@ -12,7 +12,7 @@
  *
  * @category Class
  *
- * @description Use this event to track when users make a purchase after a previous Algolia request. If you&#39;re building your category pages with Algolia, you&#39;ll also use this event.
+ * @description Use this event to track when users make a purchase after a previous Algolia request. If you're building your category pages with Algolia, you'll also use this event.
  */
 class PurchasedObjectIDsAfterSearch extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {

diff --git a/lib/Model/Insights/Value.php b/lib/Model/Insights/Value.php
@@ -12,7 +12,7 @@
  *
  * @category Class
  *
- * @description Total monetary value of this event in units of &#x60;currency&#x60;.
+ * @description Total monetary value of this event in units of `currency`.
  */
 class Value extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {

diff --git a/lib/Model/QuerySuggestions/LogLevel.php b/lib/Model/QuerySuggestions/LogLevel.php
@@ -9,7 +9,7 @@
  *
  * @category Class
  *
- * @description Type of log entry.  - &#x60;SKIP&#x60;. A query is skipped because it doesn&#39;t match the conditions for successful inclusion. For example, when a query doesn&#39;t generate enough search results. - &#x60;INFO&#x60;. An informative log entry. - &#x60;ERROR&#x60;. The Query Suggestions process encountered an error.
+ * @description Type of log entry.  - `SKIP`. A query is skipped because it doesn't match the conditions for successful inclusion. For example, when a query doesn't generate enough search results. - `INFO`. An informative log entry. - `ERROR`. The Query Suggestions process encountered an error.
  */
 class LogLevel
 {

diff --git a/lib/Model/Recommend/AroundRadius.php b/lib/Model/Recommend/AroundRadius.php
@@ -12,7 +12,7 @@
  *
  * @category Class
  *
- * @description Maximum radius for a search around a central location.  This parameter works in combination with the &#x60;aroundLatLng&#x60; and &#x60;aroundLatLngViaIP&#x60; parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates.
+ * @description Maximum radius for a search around a central location.  This parameter works in combination with the `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates.
  */
 class AroundRadius extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {

diff --git a/lib/Model/Recommend/AroundRadiusAll.php b/lib/Model/Recommend/AroundRadiusAll.php
@@ -9,7 +9,7 @@
  *
  * @category Class
  *
- * @description Return all records with a valid &#x60;_geoloc&#x60; attribute. Don&#39;t filter by distance.
+ * @description Return all records with a valid `_geoloc` attribute. Don't filter by distance.
  */
 class AroundRadiusAll
 {

diff --git a/lib/Model/Recommend/Distinct.php b/lib/Model/Recommend/Distinct.php
@@ -12,7 +12,7 @@
  *
  * @category Class
  *
- * @description Determines how many records of a group are included in the search results.  Records with the same value for the &#x60;attributeForDistinct&#x60; attribute are considered a group. The &#x60;distinct&#x60; setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).  The &#x60;distinct&#x60; setting is ignored if &#x60;attributeForDistinct&#x60; is not set.
+ * @description Determines how many records of a group are included in the search results.  Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).  The `distinct` setting is ignored if `attributeForDistinct` is not set.
  */
 class Distinct extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {

diff --git a/lib/Model/Recommend/ExactOnSingleWordQuery.php b/lib/Model/Recommend/ExactOnSingleWordQuery.php
@@ -9,7 +9,7 @@
  *
  * @category Class
  *
- * @description Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word.  - &#x60;attribute&#x60;.   The Exact ranking criterion is 1 if the query word and attribute value are the same.   For example, a search for \&quot;road\&quot; will match the value \&quot;road\&quot;, but not \&quot;road trip\&quot;.  - &#x60;none&#x60;.   The Exact ranking criterion is ignored on single-word searches.  - &#x60;word&#x60;.   The Exact ranking criterion is 1 if the query word is found in the attribute value.   The query word must have at least 3 characters and must not be a stop word.   Only exact matches will be highlighted,   partial and prefix matches won&#39;t.
+ * @description Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word.  - `attribute`.   The Exact ranking criterion is 1 if the query word and attribute value are the same.   For example, a search for \"road\" will match the value \"road\", but not \"road trip\".  - `none`.   The Exact ranking criterion is ignored on single-word searches.  - `word`.   The Exact ranking criterion is 1 if the query word is found in the attribute value.   The query word must have at least 3 characters and must not be a stop word.   Only exact matches will be highlighted,   partial and prefix matches won't.
  */
 class ExactOnSingleWordQuery
 {

diff --git a/lib/Model/Recommend/FacetFilters.php b/lib/Model/Recommend/FacetFilters.php
@@ -12,7 +12,7 @@
  *
  * @category Class
  *
- * @description Filter the search by facet values, so that only records with the same facet values are retrieved.  **Prefer using the &#x60;filters&#x60; parameter, which supports all filter types and combinations with boolean operators.**  - &#x60;[filter1, filter2]&#x60; is interpreted as &#x60;filter1 AND filter2&#x60;. - &#x60;[[filter1, filter2], filter3]&#x60; is interpreted as &#x60;filter1 OR filter2 AND filter3&#x60;. - &#x60;facet:-value&#x60; is interpreted as &#x60;NOT facet:value&#x60;.  While it&#39;s best to avoid attributes that start with a &#x60;-&#x60;, you can still filter them by escaping with a backslash: &#x60;facet:\\-value&#x60;.
+ * @description Filter the search by facet values, so that only records with the same facet values are retrieved.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`.  While it's best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`.
  */
 class FacetFilters extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {

diff --git a/lib/Model/Recommend/FbtModel.php b/lib/Model/Recommend/FbtModel.php
@@ -9,7 +9,7 @@
  *
  * @category Class
  *
- * @description Frequently bought together model.  This model recommends items that have been purchased within 1 day with the item with the ID &#x60;objectID&#x60;.
+ * @description Frequently bought together model.  This model recommends items that have been purchased within 1 day with the item with the ID `objectID`.
  */
 class FbtModel
 {

diff --git a/lib/Model/Recommend/LookingSimilarModel.php b/lib/Model/Recommend/LookingSimilarModel.php
@@ -9,7 +9,7 @@
  *
  * @category Class
  *
- * @description Looking similar model.  This model recommends items that look similar to the item with the ID &#x60;objectID&#x60; based on image attributes in your index.
+ * @description Looking similar model.  This model recommends items that look similar to the item with the ID `objectID` based on image attributes in your index.
  */
 class LookingSimilarModel
 {