diff --git a/algoliasearch/Clients/IngestionClient.cs b/algoliasearch/Clients/IngestionClient.cs index 7485b08e7..a5f215c00 100644 --- a/algoliasearch/Clients/IngestionClient.cs +++ b/algoliasearch/Clients/IngestionClient.cs @@ -980,7 +980,7 @@ public interface IIngestionClient ListDestinationsResponse ListDestinations(int? itemsPerPage = default, int? page = default, List type = default, List authenticationID = default, string transformationID = default, DestinationSortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// Retrieves a list of events for a task run, identified by it's ID. + /// Retrieves a list of events for a task run, identified by its ID. /// /// /// Required API Key ACLs: @@ -1005,7 +1005,7 @@ public interface IIngestionClient Task ListEventsAsync(string runID, int? itemsPerPage = default, int? page = default, List status = default, List type = default, EventSortKeys? sort = default, OrderKeys? order = default, string startDate = default, string endDate = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// Retrieves a list of events for a task run, identified by it's ID. (Synchronous version) + /// Retrieves a list of events for a task run, identified by its ID. (Synchronous version) /// /// /// Required API Key ACLs: diff --git a/algoliasearch/Clients/IngestionConfiguration.cs b/algoliasearch/Clients/IngestionConfiguration.cs index bee364e7b..74ca540eb 100644 --- a/algoliasearch/Clients/IngestionConfiguration.cs +++ b/algoliasearch/Clients/IngestionConfiguration.cs @@ -1,7 +1,7 @@ /* * Ingestion API * -* The Ingestion API lets you connect third-party services and platforms with Algolia and schedule tasks to ingest your data. The Ingestion API powers the no-code [data connectors](https://dashboard.algolia.com/connectors). ## Base URLs The base URLs for requests to the Ingestion API are: - `https://data.us.algolia.com` - `https://data.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: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. 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. 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. The Insights API doesn't validate if the event parameters such as `indexName`, `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the Insights API is version 1, as indicated by the `/1/` in each endpoint's URL. +* The Ingestion API lets you connect third-party services and platforms with Algolia and schedule tasks to ingest your data. The Ingestion API powers the no-code [data connectors](https://dashboard.algolia.com/connectors). ## Base URLs The base URLs for requests to the Ingestion API are: - `https://data.us.algolia.com` - `https://data.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: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. 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. 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 Ingestion 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/algoliasearch/Clients/InsightsConfiguration.cs b/algoliasearch/Clients/InsightsConfiguration.cs index c8f3b543c..e48cff8ef 100644 --- a/algoliasearch/Clients/InsightsConfiguration.cs +++ b/algoliasearch/Clients/InsightsConfiguration.cs @@ -1,7 +1,7 @@ /* * Insights API * -* The Insights API lets you collect events related to your search and discovery experience. Events represent user interactions with your app or website. They unlock powerful features, such as recommendations, personalization, smarter search results, and analytics that help you optimize your user experience. ## Client libraries Use Algolia's API clients, libraries, and integrations to collect events from your UI and send them to the Insights API. See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io` - `https://insights.de.algolia.io` - `https//insights.algolia.io` (routes requests to the closest of the above servers, based on your geographical location) **All requests must use HTTPS.** ## Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. 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. 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. The Insights API doesn't validate if the event parameters such as `indexName`, `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the Insights API is version 1, as indicated by the `/1/` in each endpoint's URL. +* The Insights API lets you collect events related to your search and discovery experience. Events represent user interactions with your app or website. They unlock powerful features, such as recommendations, personalization, smarter search results, and analytics that help you optimize your user experience. ## Client libraries Use Algolia's API clients, libraries, and integrations to collect events from your UI and send them to the Insights API. See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/). ## Base URLs The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io` - `https://insights.de.algolia.io` - `https//insights.algolia.io` (routes requests to the closest of the above servers, based on your geographical location) **All requests must use HTTPS.** ## Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. 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. 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. The Insights API doesn't validate if the event parameters such as `indexName`, `objectIDs`, or `userToken`, correspond to anything in the Search API. It just checks if they're formatted correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the Insights 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/algoliasearch/Clients/MonitoringClient.cs b/algoliasearch/Clients/MonitoringClient.cs index 5fcab8897..9ed760e88 100644 --- a/algoliasearch/Clients/MonitoringClient.cs +++ b/algoliasearch/Clients/MonitoringClient.cs @@ -132,7 +132,7 @@ public interface IMonitoringClient /// /// Retrieves known incidents for the selected clusters. /// - /// Subset of clusters, separated by comma. + /// Subset of clusters, separated by commas. /// Add extra http header or query parameters to Algolia. /// Cancellation Token to cancel the request. /// Thrown when arguments are not correct @@ -144,7 +144,7 @@ public interface IMonitoringClient /// /// Retrieves known incidents for the selected clusters. (Synchronous version) /// - /// Subset of clusters, separated by comma. + /// Subset of clusters, separated by commas. /// Add extra http header or query parameters to Algolia. /// Cancellation Token to cancel the request. /// Thrown when arguments are not correct @@ -156,7 +156,7 @@ public interface IMonitoringClient /// /// Retrieves the status of selected clusters. /// - /// Subset of clusters, separated by comma. + /// Subset of clusters, separated by commas. /// Add extra http header or query parameters to Algolia. /// Cancellation Token to cancel the request. /// Thrown when arguments are not correct @@ -168,7 +168,7 @@ public interface IMonitoringClient /// /// Retrieves the status of selected clusters. (Synchronous version) /// - /// Subset of clusters, separated by comma. + /// Subset of clusters, separated by commas. /// Add extra http header or query parameters to Algolia. /// Cancellation Token to cancel the request. /// Thrown when arguments are not correct @@ -202,7 +202,7 @@ public interface IMonitoringClient /// /// Retrieves average times for indexing operations for selected clusters. /// - /// Subset of clusters, separated by comma. + /// Subset of clusters, separated by commas. /// Add extra http header or query parameters to Algolia. /// Cancellation Token to cancel the request. /// Thrown when arguments are not correct @@ -214,7 +214,7 @@ public interface IMonitoringClient /// /// Retrieves average times for indexing operations for selected clusters. (Synchronous version) /// - /// Subset of clusters, separated by comma. + /// Subset of clusters, separated by commas. /// Add extra http header or query parameters to Algolia. /// Cancellation Token to cancel the request. /// Thrown when arguments are not correct @@ -226,7 +226,7 @@ public interface IMonitoringClient /// /// Retrieves the average latency for search requests for selected clusters. /// - /// Subset of clusters, separated by comma. + /// Subset of clusters, separated by commas. /// Add extra http header or query parameters to Algolia. /// Cancellation Token to cancel the request. /// Thrown when arguments are not correct @@ -238,7 +238,7 @@ public interface IMonitoringClient /// /// Retrieves the average latency for search requests for selected clusters. (Synchronous version) /// - /// Subset of clusters, separated by comma. + /// Subset of clusters, separated by commas. /// Add extra http header or query parameters to Algolia. /// Cancellation Token to cancel the request. /// Thrown when arguments are not correct @@ -276,7 +276,7 @@ public interface IMonitoringClient /// /// Test whether clusters are reachable or not. /// - /// Subset of clusters, separated by comma. + /// Subset of clusters, separated by commas. /// Add extra http header or query parameters to Algolia. /// Cancellation Token to cancel the request. /// Thrown when arguments are not correct @@ -288,7 +288,7 @@ public interface IMonitoringClient /// /// Test whether clusters are reachable or not. (Synchronous version) /// - /// Subset of clusters, separated by comma. + /// Subset of clusters, separated by commas. /// Add extra http header or query parameters to Algolia. /// Cancellation Token to cancel the request. /// Thrown when arguments are not correct diff --git a/algoliasearch/Models/Ingestion/Transformation.cs b/algoliasearch/Models/Ingestion/Transformation.cs index 239a9b8c8..e8294180f 100644 --- a/algoliasearch/Models/Ingestion/Transformation.cs +++ b/algoliasearch/Models/Ingestion/Transformation.cs @@ -44,9 +44,9 @@ public Transformation(string transformationID, string code, string name, string public string TransformationID { get; set; } /// - /// The authentications associated for the current transformation. + /// The authentications associated with the current transformation. /// - /// The authentications associated for the current transformation. + /// The authentications associated with the current transformation. [JsonPropertyName("authenticationIDs")] public List AuthenticationIDs { get; set; } diff --git a/algoliasearch/Models/Ingestion/TransformationCreate.cs b/algoliasearch/Models/Ingestion/TransformationCreate.cs index 315c708c3..78a5349e4 100644 --- a/algoliasearch/Models/Ingestion/TransformationCreate.cs +++ b/algoliasearch/Models/Ingestion/TransformationCreate.cs @@ -54,9 +54,9 @@ public TransformationCreate(string code, string name) public string Description { get; set; } /// - /// The authentications associated for the current transformation. + /// The authentications associated with the current transformation. /// - /// The authentications associated for the current transformation. + /// The authentications associated with the current transformation. [JsonPropertyName("authenticationIDs")] public List AuthenticationIDs { get; set; }