chore: generated code for commit 10e08c9. [skip ci]

Co-authored-by: Kai Welke <[email protected]> Co-authored-by: shortcuts <[email protected]>
algolia · Mar 28, 2024 · 693da0d · 693da0d
1 parent 10e08c9
commit 693da0d
Show file tree

Hide file tree

Showing 126 changed files with 1,900 additions and 2,495 deletions.
diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Clients/QuerySuggestionsClient.cs b/clients/algoliasearch-client-csharp/algoliasearch/Clients/QuerySuggestionsClient.cs
@@ -22,7 +22,7 @@ namespace Algolia.Search.Clients;
 public interface IQuerySuggestionsClient
 {
   /// <summary>
-  /// Create a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application. 
+  /// Creates a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application. 
   /// </summary>
   /// <param name="querySuggestionsConfigurationWithIndex"></param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -34,7 +34,7 @@ public interface IQuerySuggestionsClient
   Task<BaseResponse> CreateConfigAsync(QuerySuggestionsConfigurationWithIndex querySuggestionsConfigurationWithIndex, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// Create a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application.  (Synchronous version)
+  /// Creates a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application.  (Synchronous version)
   /// </summary>
   /// <param name="querySuggestionsConfigurationWithIndex"></param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -154,7 +154,7 @@ public interface IQuerySuggestionsClient
   object CustomPut(string path, Dictionary<string, object> parameters = default, object body = default, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// Delete a Query Suggestions configuration.  Deleting only removes the configuration and stops updates to the Query Suggestions index. The Query Suggestions index itself is not deleted. 
+  /// Deletes a Query Suggestions configuration.  Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the [Delete an index](/specs/search#tag/Indices/operation/deleteIndex) operation. 
   /// </summary>
   /// <param name="indexName">Query Suggestions index name.</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -166,7 +166,7 @@ public interface IQuerySuggestionsClient
   Task<BaseResponse> DeleteConfigAsync(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// Delete a Query Suggestions configuration.  Deleting only removes the configuration and stops updates to the Query Suggestions index. The Query Suggestions index itself is not deleted.  (Synchronous version)
+  /// Deletes a Query Suggestions configuration.  Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the [Delete an index](/specs/search#tag/Indices/operation/deleteIndex) operation.  (Synchronous version)
   /// </summary>
   /// <param name="indexName">Query Suggestions index name.</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -178,7 +178,7 @@ public interface IQuerySuggestionsClient
   BaseResponse DeleteConfig(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// List all Query Suggestions configurations of your Algolia application.
+  /// Retrieves all Query Suggestions configurations of your Algolia application.
   /// </summary>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -189,7 +189,7 @@ public interface IQuerySuggestionsClient
   Task<List<QuerySuggestionsConfigurationResponse>> GetAllConfigsAsync(RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// List all Query Suggestions configurations of your Algolia application. (Synchronous version)
+  /// Retrieves all Query Suggestions configurations of your Algolia application. (Synchronous version)
   /// </summary>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -200,7 +200,7 @@ public interface IQuerySuggestionsClient
   List<QuerySuggestionsConfigurationResponse> GetAllConfigs(RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// Get a single Query Suggestions configuration.
+  /// Retrieves a single Query Suggestions configuration by its index name.
   /// </summary>
   /// <param name="indexName">Query Suggestions index name.</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -212,7 +212,7 @@ public interface IQuerySuggestionsClient
   Task<QuerySuggestionsConfigurationResponse> GetConfigAsync(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// Get a single Query Suggestions configuration. (Synchronous version)
+  /// Retrieves a single Query Suggestions configuration by its index name. (Synchronous version)
   /// </summary>
   /// <param name="indexName">Query Suggestions index name.</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -224,7 +224,7 @@ public interface IQuerySuggestionsClient
   QuerySuggestionsConfigurationResponse GetConfig(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// Report the status of a Query Suggestions index.
+  /// Reports the status of a Query Suggestions index.
   /// </summary>
   /// <param name="indexName">Query Suggestions index name.</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -236,7 +236,7 @@ public interface IQuerySuggestionsClient
   Task<GetConfigStatus200Response> GetConfigStatusAsync(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// Report the status of a Query Suggestions index. (Synchronous version)
+  /// Reports the status of a Query Suggestions index. (Synchronous version)
   /// </summary>
   /// <param name="indexName">Query Suggestions index name.</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -248,7 +248,7 @@ public interface IQuerySuggestionsClient
   GetConfigStatus200Response GetConfigStatus(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// Get the logs for a single Query Suggestions index.
+  /// Retrieves the logs for a single Query Suggestions index.
   /// </summary>
   /// <param name="indexName">Query Suggestions index name.</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -260,7 +260,7 @@ public interface IQuerySuggestionsClient
   Task<GetLogFile200Response> GetLogFileAsync(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// Get the logs for a single Query Suggestions index. (Synchronous version)
+  /// Retrieves the logs for a single Query Suggestions index. (Synchronous version)
   /// </summary>
   /// <param name="indexName">Query Suggestions index name.</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -272,7 +272,7 @@ public interface IQuerySuggestionsClient
   GetLogFile200Response GetLogFile(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// Update a QuerySuggestions configuration.
+  /// Updates a QuerySuggestions configuration.
   /// </summary>
   /// <param name="indexName">Query Suggestions index name.</param>
   /// <param name="querySuggestionsConfiguration"></param>
@@ -285,7 +285,7 @@ public interface IQuerySuggestionsClient
   Task<BaseResponse> UpdateConfigAsync(string indexName, QuerySuggestionsConfiguration querySuggestionsConfiguration, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// Update a QuerySuggestions configuration. (Synchronous version)
+  /// Updates a QuerySuggestions configuration. (Synchronous version)
   /// </summary>
   /// <param name="indexName">Query Suggestions index name.</param>
   /// <param name="querySuggestionsConfiguration"></param>
@@ -366,7 +366,7 @@ public QuerySuggestionsClient(QuerySuggestionsConfig config, IHttpRequester http
 
 
   /// <summary>
-  /// Create a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application. 
+  /// Creates a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application. 
   /// </summary>
   ///
   /// Required API Key ACLs:
@@ -393,7 +393,7 @@ public async Task<BaseResponse> CreateConfigAsync(QuerySuggestionsConfigurationW
 
 
   /// <summary>
-  /// Create a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application.  (Synchronous version)
+  /// Creates a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application.  (Synchronous version)
   /// </summary>
   ///
   /// Required API Key ACLs:
@@ -576,7 +576,7 @@ public object CustomPut(string path, Dictionary<string, object> parameters = def
 
 
   /// <summary>
-  /// Delete a Query Suggestions configuration.  Deleting only removes the configuration and stops updates to the Query Suggestions index. The Query Suggestions index itself is not deleted. 
+  /// Deletes a Query Suggestions configuration.  Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the [Delete an index](/specs/search#tag/Indices/operation/deleteIndex) operation. 
   /// </summary>
   ///
   /// Required API Key ACLs:
@@ -603,7 +603,7 @@ public async Task<BaseResponse> DeleteConfigAsync(string indexName, RequestOptio
 
 
   /// <summary>
-  /// Delete a Query Suggestions configuration.  Deleting only removes the configuration and stops updates to the Query Suggestions index. The Query Suggestions index itself is not deleted.  (Synchronous version)
+  /// Deletes a Query Suggestions configuration.  Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the [Delete an index](/specs/search#tag/Indices/operation/deleteIndex) operation.  (Synchronous version)
   /// </summary>
   ///
   /// Required API Key ACLs:
@@ -620,7 +620,7 @@ public BaseResponse DeleteConfig(string indexName, RequestOptions options = null
 
 
   /// <summary>
-  /// List all Query Suggestions configurations of your Algolia application.
+  /// Retrieves all Query Suggestions configurations of your Algolia application.
   /// </summary>
   ///
   /// Required API Key ACLs:
@@ -641,7 +641,7 @@ public async Task<List<QuerySuggestionsConfigurationResponse>> GetAllConfigsAsyn
 
 
   /// <summary>
-  /// List all Query Suggestions configurations of your Algolia application. (Synchronous version)
+  /// Retrieves all Query Suggestions configurations of your Algolia application. (Synchronous version)
   /// </summary>
   ///
   /// Required API Key ACLs:
@@ -657,7 +657,7 @@ public List<QuerySuggestionsConfigurationResponse> GetAllConfigs(RequestOptions
 
 
   /// <summary>
-  /// Get a single Query Suggestions configuration.
+  /// Retrieves a single Query Suggestions configuration by its index name.
   /// </summary>
   ///
   /// Required API Key ACLs:
@@ -684,7 +684,7 @@ public async Task<QuerySuggestionsConfigurationResponse> GetConfigAsync(string i
 
 
   /// <summary>
-  /// Get a single Query Suggestions configuration. (Synchronous version)
+  /// Retrieves a single Query Suggestions configuration by its index name. (Synchronous version)
   /// </summary>
   ///
   /// Required API Key ACLs:
@@ -701,7 +701,7 @@ public QuerySuggestionsConfigurationResponse GetConfig(string indexName, Request
 
 
   /// <summary>
-  /// Report the status of a Query Suggestions index.
+  /// Reports the status of a Query Suggestions index.
   /// </summary>
   ///
   /// Required API Key ACLs:
@@ -728,7 +728,7 @@ public async Task<GetConfigStatus200Response> GetConfigStatusAsync(string indexN
 
 
   /// <summary>
-  /// Report the status of a Query Suggestions index. (Synchronous version)
+  /// Reports the status of a Query Suggestions index. (Synchronous version)
   /// </summary>
   ///
   /// Required API Key ACLs:
@@ -745,7 +745,7 @@ public GetConfigStatus200Response GetConfigStatus(string indexName, RequestOptio
 
 
   /// <summary>
-  /// Get the logs for a single Query Suggestions index.
+  /// Retrieves the logs for a single Query Suggestions index.
   /// </summary>
   ///
   /// Required API Key ACLs:
@@ -772,7 +772,7 @@ public async Task<GetLogFile200Response> GetLogFileAsync(string indexName, Reque
 
 
   /// <summary>
-  /// Get the logs for a single Query Suggestions index. (Synchronous version)
+  /// Retrieves the logs for a single Query Suggestions index. (Synchronous version)
   /// </summary>
   ///
   /// Required API Key ACLs:
@@ -789,7 +789,7 @@ public GetLogFile200Response GetLogFile(string indexName, RequestOptions options
 
 
   /// <summary>
-  /// Update a QuerySuggestions configuration.
+  /// Updates a QuerySuggestions configuration.
   /// </summary>
   ///
   /// Required API Key ACLs:
@@ -822,7 +822,7 @@ public async Task<BaseResponse> UpdateConfigAsync(string indexName, QuerySuggest
 
 
   /// <summary>
-  /// Update a QuerySuggestions configuration. (Synchronous version)
+  /// Updates a QuerySuggestions configuration. (Synchronous version)
   /// </summary>
   ///
   /// Required API Key ACLs:

diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Clients/QuerySuggestionsConfiguration.cs b/clients/algoliasearch-client-csharp/algoliasearch/Clients/QuerySuggestionsConfiguration.cs
@@ -1,7 +1,7 @@
 /*
 * Query Suggestions API
 *
-* The Query Suggestions API lets you manage Algolia's Query Suggestions configurations. Query Suggestions add new indices with popular search queries, external suggestions, or facet values to your Algolia application. In your user interface, you can query the Query Suggestions indices like regular indices and add [suggested searches](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/query-suggestions/js/) to guide users and speed up their search. 
+* The Query Suggestions API lets you manage your Query Suggestions configurations. Query Suggestions add new indices to your Algolia application with popular search queries, external suggestions, or facet values. In your user interface, you can query the Query Suggestions indices like regular indices and add [suggested searches](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/query-suggestions/js/) to guide users and speed up their search.  # Base URLs  The base URLs for making requests to the Query Suggestions API are:  - `https://query-suggestions.us.algolia.com` - `https://query-suggestions.eu.algolia.com`  Use the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics).  **All requests must use HTTPS.**  # Authentication  To authenticate your API requests, add these headers:  <dl> <dt><code>x-algolia-application-id</code></dt> <dd>Your Algolia application ID.</dd> <dt><code>x-algolia-api-key</code></dt> <dd> An API key with the necessary permissions to make the request. The required access control list (ACL) to make a request is listed in each endpoint's reference. </dd> </dl>  You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account).  # Request format  Request bodies must be JSON objects.  # Response status and errors  Response bodies are JSON objects. Deleting a user token returns an empty response body with rate-limiting information as headers.  Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information.  # Version  The current version of the Query Suggestions API is version 1, as indicated by the `/1/` in each endpoint's URL. 
 *
 * The version of the OpenAPI document: 1.0.0
 * Generated by: https://github.com/openapitools/openapi-generator.git

diff --git a/...QuerySuggestionsConfigurationWithIndex.cs → ...iasearch/Models/QuerySuggestions/AppID.cs b/...QuerySuggestionsConfigurationWithIndex.cs → ...iasearch/Models/QuerySuggestions/AppID.cs
@@ -12,30 +12,23 @@
 namespace Algolia.Search.Models.QuerySuggestions;
 
 /// <summary>
-/// BaseQuerySuggestionsConfigurationWithIndex
+/// AppID
 /// </summary>
-public partial class BaseQuerySuggestionsConfigurationWithIndex
+public partial class AppID
 {
   /// <summary>
-  /// Initializes a new instance of the BaseQuerySuggestionsConfigurationWithIndex class.
+  /// Initializes a new instance of the AppID class.
   /// </summary>
-  [JsonConstructor]
-  public BaseQuerySuggestionsConfigurationWithIndex() { }
-  /// <summary>
-  /// Initializes a new instance of the BaseQuerySuggestionsConfigurationWithIndex class.
-  /// </summary>
-  /// <param name="indexName">Query Suggestions index name. (required).</param>
-  public BaseQuerySuggestionsConfigurationWithIndex(string indexName)
+  public AppID()
   {
-    IndexName = indexName ?? throw new ArgumentNullException(nameof(indexName));
   }
 
   /// <summary>
-  /// Query Suggestions index name.
+  /// Algolia application ID to which this Query Suggestions configuration belongs.
   /// </summary>
-  /// <value>Query Suggestions index name.</value>
-  [JsonPropertyName("indexName")]
-  public string IndexName { get; set; }
+  /// <value>Algolia application ID to which this Query Suggestions configuration belongs.</value>
+  [JsonPropertyName("appID")]
+  public string VarAppID { get; set; }
 
   /// <summary>
   /// Returns the string presentation of the object
@@ -44,8 +37,8 @@ public BaseQuerySuggestionsConfigurationWithIndex(string indexName)
   public override string ToString()
   {
     StringBuilder sb = new StringBuilder();
-    sb.Append("class BaseQuerySuggestionsConfigurationWithIndex {\n");
-    sb.Append("  IndexName: ").Append(IndexName).Append("\n");
+    sb.Append("class AppID {\n");
+    sb.Append("  VarAppID: ").Append(VarAppID).Append("\n");
     sb.Append("}\n");
     return sb.ToString();
   }
@@ -66,13 +59,13 @@ public virtual string ToJson()
   /// <returns>Boolean</returns>
   public override bool Equals(object obj)
   {
-    if (obj is not BaseQuerySuggestionsConfigurationWithIndex input)
+    if (obj is not AppID input)
     {
       return false;
     }
 
     return
-        (IndexName == input.IndexName || (IndexName != null && IndexName.Equals(input.IndexName)));
+        (VarAppID == input.VarAppID || (VarAppID != null && VarAppID.Equals(input.VarAppID)));
   }
 
   /// <summary>
@@ -84,9 +77,9 @@ public override int GetHashCode()
     unchecked // Overflow is fine, just wrap
     {
       int hashCode = 41;
-      if (IndexName != null)
+      if (VarAppID != null)
       {
-        hashCode = (hashCode * 59) + IndexName.GetHashCode();
+        hashCode = (hashCode * 59) + VarAppID.GetHashCode();
       }
       return hashCode;
     }