diff --git a/algoliasearch/abtesting/client.py b/algoliasearch/abtesting/client.py index c46b57df7..68e251d51 100644 --- a/algoliasearch/abtesting/client.py +++ b/algoliasearch/abtesting/client.py @@ -109,10 +109,11 @@ async def add_ab_tests_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Create an A/B test. - Creates an A/B test. + Required API Key ACLs: + - editSettings + :param add_ab_tests_request: (required) :type add_ab_tests_request: AddABTestsRequest :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -144,10 +145,11 @@ async def add_ab_tests( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ABTestResponse: """ - Create an A/B test. - Creates an A/B test. + Required API Key ACLs: + - editSettings + :param add_ab_tests_request: (required) :type add_ab_tests_request: AddABTestsRequest :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -174,10 +176,9 @@ async def custom_delete_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -222,10 +223,9 @@ async def custom_delete( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -252,10 +252,9 @@ async def custom_get_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -298,10 +297,9 @@ async def custom_get( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -332,10 +330,9 @@ async def custom_post_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -389,10 +386,9 @@ async def custom_post( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -427,10 +423,9 @@ async def custom_put_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -484,10 +479,9 @@ async def custom_put( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -509,10 +503,11 @@ async def delete_ab_test_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Delete an A/B test. - Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests). + Required API Key ACLs: + - editSettings + :param id: Unique A/B test ID. (required) :type id: int :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -539,10 +534,11 @@ async def delete_ab_test( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ABTestResponse: """ - Delete an A/B test. - Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests). + Required API Key ACLs: + - editSettings + :param id: Unique A/B test ID. (required) :type id: int :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -558,10 +554,11 @@ async def get_ab_test_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get A/B test details. - Get specific details for an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests). + Required API Key ACLs: + - analytics + :param id: Unique A/B test ID. (required) :type id: int :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -586,10 +583,11 @@ async def get_ab_test( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ABTest: """ - Get A/B test details. - Get specific details for an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests). + Required API Key ACLs: + - analytics + :param id: Unique A/B test ID. (required) :type id: int :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -628,7 +626,8 @@ async def list_ab_tests_with_http_info( """ List all A/B tests. - List all A/B tests. + Required API Key ACLs: + - analytics :param offset: Position of the starting record. Used for paging. 0 is the first record. :type offset: int @@ -692,7 +691,8 @@ async def list_ab_tests( """ List all A/B tests. - List all A/B tests. + Required API Key ACLs: + - analytics :param offset: Position of the starting record. Used for paging. 0 is the first record. :type offset: int @@ -717,10 +717,11 @@ async def stop_ab_test_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Stop an A/B test. - If stopped, the test is over and can't be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests). + Required API Key ACLs: + - editSettings + :param id: Unique A/B test ID. (required) :type id: int :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -745,10 +746,11 @@ async def stop_ab_test( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ABTestResponse: """ - Stop an A/B test. - If stopped, the test is over and can't be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests). + Required API Key ACLs: + - editSettings + :param id: Unique A/B test ID. (required) :type id: int :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) diff --git a/algoliasearch/analytics/client.py b/algoliasearch/analytics/client.py index a6659c671..f2eebc702 100644 --- a/algoliasearch/analytics/client.py +++ b/algoliasearch/analytics/client.py @@ -163,10 +163,9 @@ async def custom_delete_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -211,10 +210,9 @@ async def custom_delete( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -241,10 +239,9 @@ async def custom_get_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -287,10 +284,9 @@ async def custom_get( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -321,10 +317,9 @@ async def custom_post_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -378,10 +373,9 @@ async def custom_post( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -416,10 +410,9 @@ async def custom_put_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -473,10 +466,9 @@ async def custom_put( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -516,10 +508,11 @@ async def get_average_click_position_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get average click position. - Return the average click position for the complete time range and for individual days. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param start_date: Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -582,10 +575,11 @@ async def get_average_click_position( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetAverageClickPositionResponse: """ - Get average click position. - Return the average click position for the complete time range and for individual days. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param start_date: Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -627,10 +621,11 @@ async def get_click_positions_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get click positions. - Show the number of clicks events and their associated position in the search results. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param start_date: Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -693,10 +688,11 @@ async def get_click_positions( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetClickPositionsResponse: """ - Get click positions. - Show the number of clicks events and their associated position in the search results. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param start_date: Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -738,10 +734,11 @@ async def get_click_through_rate_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get click-through rate (CTR). - Returns a [click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate). + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param start_date: Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -804,10 +801,11 @@ async def get_click_through_rate( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetClickThroughRateResponse: """ - Get click-through rate (CTR). - Returns a [click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate). + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param start_date: Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -849,10 +847,11 @@ async def get_conversation_rate_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get conversion rate (CR). - Return a [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate). + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param start_date: Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -915,10 +914,11 @@ async def get_conversation_rate( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetConversationRateResponse: """ - Get conversion rate (CR). - Return a [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate). + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param start_date: Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -960,10 +960,11 @@ async def get_no_click_rate_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get no click rate. - Returns the rate at which searches don't lead to any clicks. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without clicks. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param start_date: Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -1026,10 +1027,11 @@ async def get_no_click_rate( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetNoClickRateResponse: """ - Get no click rate. - Returns the rate at which searches don't lead to any clicks. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without clicks. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param start_date: Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -1071,10 +1073,11 @@ async def get_no_results_rate_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get no results rate. - Returns the rate at which searches didn't return any results. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param start_date: Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -1137,10 +1140,11 @@ async def get_no_results_rate( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetNoResultsRateResponse: """ - Get no results rate. - Returns the rate at which searches didn't return any results. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param start_date: Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -1182,10 +1186,11 @@ async def get_searches_count_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get number of searches. - Returns the number of searches within a time range. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param start_date: Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -1248,10 +1253,11 @@ async def get_searches_count( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetSearchesCountResponse: """ - Get number of searches. - Returns the number of searches within a time range. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param start_date: Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -1303,10 +1309,11 @@ async def get_searches_no_clicks_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get top searches with no clicks. - Return the most popular of the last 1,000 searches that didn't lead to any clicks. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param start_date: Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -1387,10 +1394,11 @@ async def get_searches_no_clicks( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetSearchesNoClicksResponse: """ - Get top searches with no clicks. - Return the most popular of the last 1,000 searches that didn't lead to any clicks. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param start_date: Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -1446,10 +1454,11 @@ async def get_searches_no_results_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get top searches with no results. - Returns the most popular of the latest 1,000 searches that didn't return any results. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param start_date: Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -1530,10 +1539,11 @@ async def get_searches_no_results( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetSearchesNoResultsResponse: """ - Get top searches with no results. - Returns the most popular of the latest 1,000 searches that didn't return any results. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param start_date: Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -1561,10 +1571,11 @@ async def get_status_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get Analytics API status. - Return the latest update time of the Analytics API for an index. If the index has been recently created or no search has been performed yet, `updatedAt` will be `null`. > **Note**: The Analytics API is updated every 5 minutes. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1595,10 +1606,11 @@ async def get_status( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetStatusResponse: """ - Get Analytics API status. - Return the latest update time of the Analytics API for an index. If the index has been recently created or no search has been performed yet, `updatedAt` will be `null`. > **Note**: The Analytics API is updated every 5 minutes. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1642,10 +1654,11 @@ async def get_top_countries_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get top countries. - Returns top countries. Limited to the 1,000 most frequent ones. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param start_date: Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -1726,10 +1739,11 @@ async def get_top_countries( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetTopCountriesResponse: """ - Get top countries. - Returns top countries. Limited to the 1,000 most frequent ones. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param start_date: Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -1786,10 +1800,11 @@ async def get_top_filter_attributes_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get top filterable attributes. - Return the most popular [filterable attributes](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) in the 1,000 most recently used filters. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param search: User query. @@ -1875,10 +1890,11 @@ async def get_top_filter_attributes( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetTopFilterAttributesResponse: """ - Get top filterable attributes. - Return the most popular [filterable attributes](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) in the 1,000 most recently used filters. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param search: User query. @@ -1945,10 +1961,11 @@ async def get_top_filter_for_attribute_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get top filter values for an attribute. - Returns the most popular filter values for an attribute in the 1,000 most recently used filters. + Required API Key ACLs: + - analytics + :param attribute: Attribute name. (required) :type attribute: str :param index: Index name to target. (required) @@ -2044,10 +2061,11 @@ async def get_top_filter_for_attribute( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetTopFilterForAttributeResponse: """ - Get top filter values for an attribute. - Returns the most popular filter values for an attribute in the 1,000 most recently used filters. + Required API Key ACLs: + - analytics + :param attribute: Attribute name. (required) :type attribute: str :param index: Index name to target. (required) @@ -2116,10 +2134,11 @@ async def get_top_filters_no_results_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get top filters for a no result search. - Returns top filters for filter-enabled searches that don't return results. Limited to the 1,000 most recently used filters. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param search: User query. @@ -2205,10 +2224,11 @@ async def get_top_filters_no_results( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetTopFiltersNoResultsResponse: """ - Get top filters for a no result search. - Returns top filters for filter-enabled searches that don't return results. Limited to the 1,000 most recently used filters. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param search: User query. @@ -2280,10 +2300,11 @@ async def get_top_hits_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get top hits. - Return the most popular clicked results in the last 1,000 searches. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param search: User query. @@ -2379,10 +2400,11 @@ async def get_top_hits( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetTopHitsResponse: """ - Get top hits. - Return the most popular clicked results in the last 1,000 searches. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param search: User query. @@ -2465,10 +2487,11 @@ async def get_top_searches_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get top searches. - Returns the most popular of the latest 1,000 searches. For each search, also returns the number of hits. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param click_analytics: Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search. @@ -2576,10 +2599,11 @@ async def get_top_searches( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetTopSearchesResponse: """ - Get top searches. - Returns the most popular of the latest 1,000 searches. For each search, also returns the number of hits. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param click_analytics: Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search. @@ -2640,10 +2664,11 @@ async def get_users_count_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get user count. - Return the count of unique users. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param start_date: Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -2706,10 +2731,11 @@ async def get_users_count( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetUsersCountResponse: """ - Get user count. - Return the count of unique users. + Required API Key ACLs: + - analytics + :param index: Index name to target. (required) :type index: str :param start_date: Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. diff --git a/algoliasearch/ingestion/client.py b/algoliasearch/ingestion/client.py index 58bd2d53a..bc8094974 100644 --- a/algoliasearch/ingestion/client.py +++ b/algoliasearch/ingestion/client.py @@ -173,7 +173,10 @@ async def create_authentication_with_http_info( """ Create a authentication. - Create a authentication. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings :param authentication_create: (required) :type authentication_create: AuthenticationCreate @@ -208,7 +211,10 @@ async def create_authentication( """ Create a authentication. - Create a authentication. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings :param authentication_create: (required) :type authentication_create: AuthenticationCreate @@ -229,7 +235,10 @@ async def create_destination_with_http_info( """ Create a destination. - Create a destination. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings :param destination_create: (required) :type destination_create: DestinationCreate @@ -264,7 +273,10 @@ async def create_destination( """ Create a destination. - Create a destination. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings :param destination_create: (required) :type destination_create: DestinationCreate @@ -285,7 +297,10 @@ async def create_source_with_http_info( """ Create a source. - Create a source. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings :param source_create: (required) :type source_create: SourceCreate @@ -320,7 +335,10 @@ async def create_source( """ Create a source. - Create a source. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings :param source_create: (required) :type source_create: SourceCreate @@ -339,7 +357,6 @@ async def create_task_with_http_info( """ Create a task. - Create a task. :param task_create: (required) :type task_create: TaskCreate @@ -374,7 +391,6 @@ async def create_task( """ Create a task. - Create a task. :param task_create: (required) :type task_create: TaskCreate @@ -400,10 +416,9 @@ async def custom_delete_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -448,10 +463,9 @@ async def custom_delete( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -478,10 +492,9 @@ async def custom_get_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -524,10 +537,9 @@ async def custom_get( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -558,10 +570,9 @@ async def custom_post_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -615,10 +626,9 @@ async def custom_post( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -653,10 +663,9 @@ async def custom_put_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -710,10 +719,9 @@ async def custom_put( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -737,10 +745,13 @@ async def delete_authentication_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Delete a authentication. - Soft delete the authentication of the given authenticationID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param authentication_id: The authentication UUID. (required) :type authentication_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -771,10 +782,13 @@ async def delete_authentication( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> DeleteResponse: """ - Delete a authentication. - Soft delete the authentication of the given authenticationID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param authentication_id: The authentication UUID. (required) :type authentication_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -794,10 +808,13 @@ async def delete_destination_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Delete a destination. - Soft delete the destination of the given destinationID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param destination_id: The destination UUID. (required) :type destination_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -828,10 +845,13 @@ async def delete_destination( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> DeleteResponse: """ - Delete a destination. - Soft delete the destination of the given destinationID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param destination_id: The destination UUID. (required) :type destination_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -849,10 +869,13 @@ async def delete_source_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Delete a source. - Soft delete the source of the given sourceID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param source_id: The source UUID. (required) :type source_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -881,10 +904,13 @@ async def delete_source( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> DeleteResponse: """ - Delete a source. - Soft delete the source of the given sourceID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param source_id: The source UUID. (required) :type source_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -900,10 +926,9 @@ async def delete_task_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Delete a task. - Soft delete the task of the given taskID. + :param task_id: The task UUID. (required) :type task_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -930,10 +955,9 @@ async def delete_task( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> DeleteResponse: """ - Delete a task. - Soft delete the task of the given taskID. + :param task_id: The task UUID. (required) :type task_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -949,10 +973,13 @@ async def disable_task_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Disable a task. - Disable the task of the given taskID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param task_id: The task UUID. (required) :type task_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -981,10 +1008,13 @@ async def disable_task( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> TaskUpdateResponse: """ - Disable a task. - Disable the task of the given taskID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param task_id: The task UUID. (required) :type task_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1000,10 +1030,13 @@ async def enable_task_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Enable a task. - Enable the task of the given taskID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param task_id: The task UUID. (required) :type task_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1032,10 +1065,13 @@ async def enable_task( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> TaskUpdateResponse: """ - Enable a task. - Enable the task of the given taskID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param task_id: The task UUID. (required) :type task_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1053,10 +1089,13 @@ async def get_authentication_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get a authentication. - Get the authentication of the given authenticationID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param authentication_id: The authentication UUID. (required) :type authentication_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1087,10 +1126,13 @@ async def get_authentication( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> Authentication: """ - Get a authentication. - Get the authentication of the given authenticationID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param authentication_id: The authentication UUID. (required) :type authentication_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1130,10 +1172,13 @@ async def get_authentications_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get a list of authentications. - Get a list of authentications for the given query parameters, with pagination details. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param items_per_page: The number of items per page to return. :type items_per_page: int :param page: The page number to fetch, starting at 1. @@ -1203,10 +1248,13 @@ async def get_authentications( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ListAuthenticationsResponse: """ - Get a list of authentications. - Get a list of authentications for the given query parameters, with pagination details. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param items_per_page: The number of items per page to return. :type items_per_page: int :param page: The page number to fetch, starting at 1. @@ -1236,10 +1284,13 @@ async def get_destination_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get a destination. - Get the destination of the given destinationID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param destination_id: The destination UUID. (required) :type destination_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1270,10 +1321,13 @@ async def get_destination( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> Destination: """ - Get a destination. - Get the destination of the given destinationID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param destination_id: The destination UUID. (required) :type destination_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1311,10 +1365,13 @@ async def get_destinations_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get a list of destinations. - Get a list of destinations for the given query parameters, with pagination details. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param items_per_page: The number of items per page to return. :type items_per_page: int :param page: The page number to fetch, starting at 1. @@ -1384,10 +1441,13 @@ async def get_destinations( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ListDestinationsResponse: """ - Get a list of destinations. - Get a list of destinations for the given query parameters, with pagination details. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param items_per_page: The number of items per page to return. :type items_per_page: int :param page: The page number to fetch, starting at 1. @@ -1421,10 +1481,13 @@ async def get_docker_source_streams_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Retrieve a stream listing. - Retrieve a stream listing for a given Singer specification compatible docker type source ID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param source_id: The source UUID. (required) :type source_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1453,10 +1516,13 @@ async def get_docker_source_streams( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> DockerSourceStreams: """ - Retrieve a stream listing. - Retrieve a stream listing for a given Singer specification compatible docker type source ID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param source_id: The source UUID. (required) :type source_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1475,10 +1541,13 @@ async def get_event_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get an event. - Get a single event for a specific runID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param run_id: The run UUID. (required) :type run_id: str :param event_id: The event UUID. (required) @@ -1513,10 +1582,13 @@ async def get_event( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> Event: """ - Get an event. - Get a single event for a specific runID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param run_id: The run UUID. (required) :type run_id: str :param event_id: The event UUID. (required) @@ -1569,10 +1641,13 @@ async def get_events_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get a list of events. - Get a list of events associated to the given runID, for the given query parameters. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param run_id: The run UUID. (required) :type run_id: str :param items_per_page: The number of items per page to return. @@ -1672,10 +1747,13 @@ async def get_events( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ListEventsResponse: """ - Get a list of events. - Get a list of events associated to the given runID, for the given query parameters. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param run_id: The run UUID. (required) :type run_id: str :param items_per_page: The number of items per page to return. @@ -1718,10 +1796,13 @@ async def get_run_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get a run. - Get a single run for the given ID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param run_id: The run UUID. (required) :type run_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1746,10 +1827,13 @@ async def get_run( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> Run: """ - Get a run. - Get a single run for the given ID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param run_id: The run UUID. (required) :type run_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1798,10 +1882,13 @@ async def get_runs_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get a list of runs. - Get a list of runs for the given query parameters, with pagination details. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param items_per_page: The number of items per page to return. :type items_per_page: int :param page: The page number to fetch, starting at 1. @@ -1890,10 +1977,13 @@ async def get_runs( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> RunListResponse: """ - Get a list of runs. - Get a list of runs for the given query parameters, with pagination details. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param items_per_page: The number of items per page to return. :type items_per_page: int :param page: The page number to fetch, starting at 1. @@ -1933,10 +2023,13 @@ async def get_source_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get a source. - Get the source of the given sourceID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param source_id: The source UUID. (required) :type source_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1965,10 +2058,13 @@ async def get_source( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> Source: """ - Get a source. - Get the source of the given sourceID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param source_id: The source UUID. (required) :type source_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2008,10 +2104,13 @@ async def get_sources_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get a list of sources. - Get a list of sources for the given query parameters, with pagination details. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param items_per_page: The number of items per page to return. :type items_per_page: int :param page: The page number to fetch, starting at 1. @@ -2083,10 +2182,13 @@ async def get_sources( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ListSourcesResponse: """ - Get a list of sources. - Get a list of sources for the given query parameters, with pagination details. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param items_per_page: The number of items per page to return. :type items_per_page: int :param page: The page number to fetch, starting at 1. @@ -2120,10 +2222,13 @@ async def get_task_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get a task. - Get the task of the given taskID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param task_id: The task UUID. (required) :type task_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2148,10 +2253,13 @@ async def get_task( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> Task: """ - Get a task. - Get the task of the given taskID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param task_id: The task UUID. (required) :type task_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2201,10 +2309,13 @@ async def get_tasks_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get a list of tasks. - Get a list of tasks for the given query parameters, with pagination details. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param items_per_page: The number of items per page to return. :type items_per_page: int :param page: The page number to fetch, starting at 1. @@ -2298,10 +2409,13 @@ async def get_tasks( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ListTasksResponse: """ - Get a list of tasks. - Get a list of tasks for the given query parameters, with pagination details. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param items_per_page: The number of items per page to return. :type items_per_page: int :param page: The page number to fetch, starting at 1. @@ -2344,10 +2458,13 @@ async def run_task_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Run a task. - Run the task of the given taskID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param task_id: The task UUID. (required) :type task_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2374,10 +2491,13 @@ async def run_task( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> RunResponse: """ - Run a task. - Run the task of the given taskID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param task_id: The task UUID. (required) :type task_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2393,10 +2513,13 @@ async def search_authentications_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Search among authentications. - Search among authentications with a defined set of parameters. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param authentication_search: (required) :type authentication_search: AuthenticationSearch :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2428,10 +2551,13 @@ async def search_authentications( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> List[Authentication]: """ - Search among authentications. - Search among authentications with a defined set of parameters. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param authentication_search: (required) :type authentication_search: AuthenticationSearch :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2449,10 +2575,13 @@ async def search_destinations_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Search among destinations. - Search among destinations with a defined set of parameters. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param destination_search: (required) :type destination_search: DestinationSearch :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2484,10 +2613,13 @@ async def search_destinations( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> List[Destination]: """ - Search among destinations. - Search among destinations with a defined set of parameters. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param destination_search: (required) :type destination_search: DestinationSearch :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2505,10 +2637,13 @@ async def search_sources_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Search among sources. - Search among sources with a defined set of parameters. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param source_search: (required) :type source_search: SourceSearch :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2540,10 +2675,13 @@ async def search_sources( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> List[Source]: """ - Search among sources. - Search among sources with a defined set of parameters. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param source_search: (required) :type source_search: SourceSearch :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2559,10 +2697,13 @@ async def search_tasks_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Search among tasks. - Search among tasks with a defined set of parameters. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param task_search: (required) :type task_search: TaskSearch :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2594,10 +2735,13 @@ async def search_tasks( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> List[Task]: """ - Search among tasks. - Search among tasks with a defined set of parameters. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param task_search: (required) :type task_search: TaskSearch :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2613,10 +2757,13 @@ async def trigger_docker_source_discover_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Trigger a stream listing request. - Trigger a stream listing request for a Singer specification compatible docker type source. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param source_id: The source UUID. (required) :type source_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2645,10 +2792,13 @@ async def trigger_docker_source_discover( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> DockerSourceDiscover: """ - Trigger a stream listing request. - Trigger a stream listing request for a Singer specification compatible docker type source. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param source_id: The source UUID. (required) :type source_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2669,10 +2819,13 @@ async def update_authentication_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Update a authentication. - Update the authentication of the given authenticationID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param authentication_id: The authentication UUID. (required) :type authentication_id: str :param authentication_update: (required) @@ -2716,10 +2869,13 @@ async def update_authentication( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> AuthenticationUpdateResponse: """ - Update a authentication. - Update the authentication of the given authenticationID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param authentication_id: The authentication UUID. (required) :type authentication_id: str :param authentication_update: (required) @@ -2742,10 +2898,13 @@ async def update_destination_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Update a destination. - Update the destination of the given destinationID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param destination_id: The destination UUID. (required) :type destination_id: str :param destination_update: (required) @@ -2789,10 +2948,13 @@ async def update_destination( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> DestinationUpdateResponse: """ - Update a destination. - Update the destination of the given destinationID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param destination_id: The destination UUID. (required) :type destination_id: str :param destination_update: (required) @@ -2813,10 +2975,13 @@ async def update_source_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Update a source. - Update the source of the given sourceID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param source_id: The source UUID. (required) :type source_id: str :param source_update: (required) @@ -2858,10 +3023,13 @@ async def update_source( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> SourceUpdateResponse: """ - Update a source. - Update the source of the given sourceID. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + :param source_id: The source UUID. (required) :type source_id: str :param source_update: (required) @@ -2882,10 +3050,9 @@ async def update_task_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Update a task. - Update the task of the given taskID. + :param task_id: The task UUID. (required) :type task_id: str :param task_update: (required) @@ -2925,10 +3092,9 @@ async def update_task( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> TaskUpdateResponse: """ - Update a task. - Update the task of the given taskID. + :param task_id: The task UUID. (required) :type task_id: str :param task_update: (required) diff --git a/algoliasearch/insights/client.py b/algoliasearch/insights/client.py index 6fad64d16..d78e66fb6 100644 --- a/algoliasearch/insights/client.py +++ b/algoliasearch/insights/client.py @@ -116,10 +116,9 @@ async def custom_delete_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -164,10 +163,9 @@ async def custom_delete( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -194,10 +192,9 @@ async def custom_get_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -240,10 +237,9 @@ async def custom_get( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -274,10 +270,9 @@ async def custom_post_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -331,10 +326,9 @@ async def custom_post( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -369,10 +363,9 @@ async def custom_put_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -426,10 +419,9 @@ async def custom_put( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -459,10 +451,9 @@ async def delete_user_token_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Delete user token. - Delete all events related to a certain user token from events metrics and analytics. To delete a personalization user profile, see [Delete a user profile](https://www.algolia.com/doc/rest-api/personalization/#delete-a-user-profile). + :param user_token: The user token for which to delete all associated events. (required) :type user_token: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -499,10 +490,9 @@ async def delete_user_token( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> None: """ - Delete user token. - Delete all events related to a certain user token from events metrics and analytics. To delete a personalization user profile, see [Delete a user profile](https://www.algolia.com/doc/rest-api/personalization/#delete-a-user-profile). + :param user_token: The user token for which to delete all associated events. (required) :type user_token: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -517,10 +507,9 @@ async def push_events_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send events. - Send a list of events to the Insights API. You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB. + :param insights_events: (required) :type insights_events: InsightsEvents :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -552,10 +541,9 @@ async def push_events( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> EventsResponse: """ - Send events. - Send a list of events to the Insights API. You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB. + :param insights_events: (required) :type insights_events: InsightsEvents :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) diff --git a/algoliasearch/monitoring/client.py b/algoliasearch/monitoring/client.py index 5075d6b57..a190638f6 100644 --- a/algoliasearch/monitoring/client.py +++ b/algoliasearch/monitoring/client.py @@ -122,10 +122,9 @@ async def custom_delete_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -170,10 +169,9 @@ async def custom_delete( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -200,10 +198,9 @@ async def custom_get_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -246,10 +243,9 @@ async def custom_get( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -280,10 +276,9 @@ async def custom_post_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -337,10 +332,9 @@ async def custom_post( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -375,10 +369,9 @@ async def custom_put_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -432,10 +425,9 @@ async def custom_put( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -459,10 +451,9 @@ async def get_cluster_incidents_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - List incidents for selected clusters. - List known incidents for selected clusters. + :param clusters: Subset of clusters, separated by comma. (required) :type clusters: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -493,10 +484,9 @@ async def get_cluster_incidents( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> IncidentsResponse: """ - List incidents for selected clusters. - List known incidents for selected clusters. + :param clusters: Subset of clusters, separated by comma. (required) :type clusters: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -514,10 +504,9 @@ async def get_cluster_status_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - List statuses of selected clusters. - Report whether a cluster is operational. + :param clusters: Subset of clusters, separated by comma. (required) :type clusters: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -548,10 +537,9 @@ async def get_cluster_status( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> StatusResponse: """ - List statuses of selected clusters. - Report whether a cluster is operational. + :param clusters: Subset of clusters, separated by comma. (required) :type clusters: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -565,10 +553,9 @@ async def get_incidents_with_http_info( self, request_options: Optional[Union[dict, RequestOptions]] = None ) -> ApiResponse[str]: """ - List incidents. - List known incidents for all clusters. + :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) :return: Returns the raw algoliasearch 'APIResponse' object. """ @@ -586,10 +573,9 @@ async def get_incidents( self, request_options: Optional[Union[dict, RequestOptions]] = None ) -> IncidentsResponse: """ - List incidents. - List known incidents for all clusters. + :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) :return: Returns the deserialized response in a 'IncidentsResponse' result object. """ @@ -605,10 +591,9 @@ async def get_indexing_time_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get indexing times. - List the average times for indexing operations for selected clusters. + :param clusters: Subset of clusters, separated by comma. (required) :type clusters: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -639,10 +624,9 @@ async def get_indexing_time( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> IndexingTimeResponse: """ - Get indexing times. - List the average times for indexing operations for selected clusters. + :param clusters: Subset of clusters, separated by comma. (required) :type clusters: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -656,10 +640,9 @@ async def get_inventory_with_http_info( self, request_options: Optional[Union[dict, RequestOptions]] = None ) -> ApiResponse[str]: """ - List servers. - List the servers belonging to clusters. The response depends on whether you authenticate your API request: - With authentication, the response lists the servers assigned to your Algolia application's cluster. - Without authentication, the response lists the servers for all Algolia clusters. + :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) :return: Returns the raw algoliasearch 'APIResponse' object. """ @@ -677,10 +660,9 @@ async def get_inventory( self, request_options: Optional[Union[dict, RequestOptions]] = None ) -> InventoryResponse: """ - List servers. - List the servers belonging to clusters. The response depends on whether you authenticate your API request: - With authentication, the response lists the servers assigned to your Algolia application's cluster. - Without authentication, the response lists the servers for all Algolia clusters. + :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) :return: Returns the deserialized response in a 'InventoryResponse' result object. """ @@ -696,10 +678,9 @@ async def get_latency_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get search latency times. - List the average latency for search requests for selected clusters. + :param clusters: Subset of clusters, separated by comma. (required) :type clusters: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -730,10 +711,9 @@ async def get_latency( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> LatencyResponse: """ - Get search latency times. - List the average latency for search requests for selected clusters. + :param clusters: Subset of clusters, separated by comma. (required) :type clusters: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -760,10 +740,9 @@ async def get_metrics_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get metrics for a given period. - Report the aggregate value of a metric for a selected period of time. + :param metric: Metric to report. For more information about the individual metrics, see the response. To include all metrics, use `*` as the parameter. (required) :type metric: Metric :param 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) @@ -810,10 +789,9 @@ async def get_metrics( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> InfrastructureResponse: """ - Get metrics for a given period. - Report the aggregate value of a metric for a selected period of time. + :param metric: Metric to report. For more information about the individual metrics, see the response. To include all metrics, use `*` as the parameter. (required) :type metric: Metric :param 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) @@ -833,10 +811,9 @@ async def get_reachability_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Test the reachability of clusters. - Test whether clusters are reachable or not. + :param clusters: Subset of clusters, separated by comma. (required) :type clusters: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -867,10 +844,9 @@ async def get_reachability( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> Dict[str, Dict[str, bool]]: """ - Test the reachability of clusters. - Test whether clusters are reachable or not. + :param clusters: Subset of clusters, separated by comma. (required) :type clusters: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -884,10 +860,9 @@ async def get_status_with_http_info( self, request_options: Optional[Union[dict, RequestOptions]] = None ) -> ApiResponse[str]: """ - List cluster statuses. - Report whether clusters are operational. The response depends on whether you authenticate your API request. - With authentication, the response includes the status of the cluster assigned to your Algolia application. - Without authentication, the response lists the statuses of all public Algolia clusters. + :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) :return: Returns the raw algoliasearch 'APIResponse' object. """ @@ -905,10 +880,9 @@ async def get_status( self, request_options: Optional[Union[dict, RequestOptions]] = None ) -> StatusResponse: """ - List cluster statuses. - Report whether clusters are operational. The response depends on whether you authenticate your API request. - With authentication, the response includes the status of the cluster assigned to your Algolia application. - Without authentication, the response lists the statuses of all public Algolia clusters. + :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) :return: Returns the deserialized response in a 'StatusResponse' result object. """ diff --git a/algoliasearch/personalization/client.py b/algoliasearch/personalization/client.py index 1d13de0c0..3cf6a0ac0 100644 --- a/algoliasearch/personalization/client.py +++ b/algoliasearch/personalization/client.py @@ -126,10 +126,9 @@ async def custom_delete_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -174,10 +173,9 @@ async def custom_delete( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -204,10 +202,9 @@ async def custom_get_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -250,10 +247,9 @@ async def custom_get( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -284,10 +280,9 @@ async def custom_post_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -341,10 +336,9 @@ async def custom_post( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -379,10 +373,9 @@ async def custom_put_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -436,10 +429,9 @@ async def custom_put( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -466,10 +458,11 @@ async def delete_user_profile_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Delete a user profile. - Delete the user profile and all its associated data. Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile. It might take a couple hours for the deletion request to be fully processed. + Required API Key ACLs: + - recommendation + :param user_token: userToken representing the user for which to fetch the Personalization profile. (required) :type user_token: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -503,10 +496,11 @@ async def delete_user_profile( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> DeleteUserProfileResponse: """ - Delete a user profile. - Delete the user profile and all its associated data. Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile. It might take a couple hours for the deletion request to be fully processed. + Required API Key ACLs: + - recommendation + :param user_token: userToken representing the user for which to fetch the Personalization profile. (required) :type user_token: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -520,10 +514,11 @@ async def get_personalization_strategy_with_http_info( self, request_options: Optional[Union[dict, RequestOptions]] = None ) -> ApiResponse[str]: """ - Get the current strategy. - The strategy contains information on the events and facets that impact user profiles and personalized search results. + Required API Key ACLs: + - recommendation + :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) :return: Returns the raw algoliasearch 'APIResponse' object. """ @@ -541,10 +536,11 @@ async def get_personalization_strategy( self, request_options: Optional[Union[dict, RequestOptions]] = None ) -> PersonalizationStrategyParams: """ - Get the current strategy. - The strategy contains information on the events and facets that impact user profiles and personalized search results. + Required API Key ACLs: + - recommendation + :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) :return: Returns the deserialized response in a 'PersonalizationStrategyParams' result object. """ @@ -563,10 +559,11 @@ async def get_user_token_profile_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get a user profile. - Get the user profile built from Personalization strategy. The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes. + Required API Key ACLs: + - recommendation + :param user_token: userToken representing the user for which to fetch the Personalization profile. (required) :type user_token: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -600,10 +597,11 @@ async def get_user_token_profile( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetUserTokenResponse: """ - Get a user profile. - Get the user profile built from Personalization strategy. The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes. + Required API Key ACLs: + - recommendation + :param user_token: userToken representing the user for which to fetch the Personalization profile. (required) :type user_token: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -621,10 +619,11 @@ async def set_personalization_strategy_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Set a new strategy. - A strategy defines the events and facets that impact user profiles and personalized search results. + Required API Key ACLs: + - recommendation + :param personalization_strategy_params: (required) :type personalization_strategy_params: PersonalizationStrategyParams :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -656,10 +655,11 @@ async def set_personalization_strategy( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> SetPersonalizationStrategyResponse: """ - Set a new strategy. - A strategy defines the events and facets that impact user profiles and personalized search results. + Required API Key ACLs: + - recommendation + :param personalization_strategy_params: (required) :type personalization_strategy_params: PersonalizationStrategyParams :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) diff --git a/algoliasearch/query_suggestions/client.py b/algoliasearch/query_suggestions/client.py index d262c0276..e96586362 100644 --- a/algoliasearch/query_suggestions/client.py +++ b/algoliasearch/query_suggestions/client.py @@ -121,10 +121,11 @@ async def create_config_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Create a configuration. - Create a new Query Suggestions configuration. You can have up to 100 configurations per Algolia application. + Required API Key ACLs: + - editSettings + :param query_suggestions_configuration_with_index: (required) :type query_suggestions_configuration_with_index: QuerySuggestionsConfigurationWithIndex :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -156,10 +157,11 @@ async def create_config( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> BaseResponse: """ - Create a configuration. - Create a new Query Suggestions configuration. You can have up to 100 configurations per Algolia application. + Required API Key ACLs: + - editSettings + :param query_suggestions_configuration_with_index: (required) :type query_suggestions_configuration_with_index: QuerySuggestionsConfigurationWithIndex :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -186,10 +188,9 @@ async def custom_delete_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -234,10 +235,9 @@ async def custom_delete( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -264,10 +264,9 @@ async def custom_get_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -310,10 +309,9 @@ async def custom_get( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -344,10 +342,9 @@ async def custom_post_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -401,10 +398,9 @@ async def custom_post( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -439,10 +435,9 @@ async def custom_put_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -496,10 +491,9 @@ async def custom_put( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -523,10 +517,11 @@ async def delete_config_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Delete a configuration. - 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. + Required API Key ACLs: + - editSettings + :param index_name: Query Suggestions index name. (required) :type index_name: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -557,10 +552,11 @@ async def delete_config( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> BaseResponse: """ - Delete a configuration. - 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. + Required API Key ACLs: + - editSettings + :param index_name: Query Suggestions index name. (required) :type index_name: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -574,10 +570,11 @@ async def get_all_configs_with_http_info( self, request_options: Optional[Union[dict, RequestOptions]] = None ) -> ApiResponse[str]: """ - List configurations. - List all Query Suggestions configurations of your Algolia application. + Required API Key ACLs: + - settings + :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) :return: Returns the raw algoliasearch 'APIResponse' object. """ @@ -595,10 +592,11 @@ async def get_all_configs( self, request_options: Optional[Union[dict, RequestOptions]] = None ) -> List[QuerySuggestionsConfigurationResponse]: """ - List configurations. - List all Query Suggestions configurations of your Algolia application. + Required API Key ACLs: + - settings + :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) :return: Returns the deserialized response in a 'List[QuerySuggestionsConfigurationResponse]' result object. """ @@ -614,10 +612,11 @@ async def get_config_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get a configuration. - Get a single Query Suggestions configuration. + Required API Key ACLs: + - settings + :param index_name: Query Suggestions index name. (required) :type index_name: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -648,10 +647,11 @@ async def get_config( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> QuerySuggestionsConfigurationResponse: """ - Get a configuration. - Get a single Query Suggestions configuration. + Required API Key ACLs: + - settings + :param index_name: Query Suggestions index name. (required) :type index_name: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -669,10 +669,11 @@ async def get_config_status_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get configuration status. - Report the status of a Query Suggestions index. + Required API Key ACLs: + - settings + :param index_name: Query Suggestions index name. (required) :type index_name: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -703,10 +704,11 @@ async def get_config_status( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetConfigStatus200Response: """ - Get configuration status. - Report the status of a Query Suggestions index. + Required API Key ACLs: + - settings + :param index_name: Query Suggestions index name. (required) :type index_name: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -724,10 +726,11 @@ async def get_log_file_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get logs. - Get the logs for a single Query Suggestions index. + Required API Key ACLs: + - settings + :param index_name: Query Suggestions index name. (required) :type index_name: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -758,10 +761,11 @@ async def get_log_file( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetLogFile200Response: """ - Get logs. - Get the logs for a single Query Suggestions index. + Required API Key ACLs: + - settings + :param index_name: Query Suggestions index name. (required) :type index_name: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -780,10 +784,11 @@ async def update_config_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Update a configuration. - Update a QuerySuggestions configuration. + Required API Key ACLs: + - editSettings + :param index_name: Query Suggestions index name. (required) :type index_name: str :param query_suggestions_configuration: (required) @@ -827,10 +832,11 @@ async def update_config( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> BaseResponse: """ - Update a configuration. - Update a QuerySuggestions configuration. + Required API Key ACLs: + - editSettings + :param index_name: Query Suggestions index name. (required) :type index_name: str :param query_suggestions_configuration: (required) diff --git a/algoliasearch/recommend/client.py b/algoliasearch/recommend/client.py index 42d9ffde2..c54808ee7 100644 --- a/algoliasearch/recommend/client.py +++ b/algoliasearch/recommend/client.py @@ -130,10 +130,9 @@ async def custom_delete_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -178,10 +177,9 @@ async def custom_delete( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -208,10 +206,9 @@ async def custom_get_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -254,10 +251,9 @@ async def custom_get( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -288,10 +284,9 @@ async def custom_post_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -345,10 +340,9 @@ async def custom_post( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -383,10 +377,9 @@ async def custom_put_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -440,10 +433,9 @@ async def custom_put( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -476,10 +468,11 @@ async def delete_recommend_rule_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Delete a Recommend rule. - Delete a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/). + Required API Key ACLs: + - editSettings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param model: [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required) @@ -535,10 +528,11 @@ async def delete_recommend_rule( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> DeletedAtResponse: """ - Delete a Recommend rule. - Delete a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/). + Required API Key ACLs: + - editSettings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param model: [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required) @@ -571,10 +565,11 @@ async def get_recommend_rule_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get a Recommend rule. - Return a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/). + Required API Key ACLs: + - settings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param model: [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required) @@ -630,10 +625,11 @@ async def get_recommend_rule( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> RuleResponse: """ - Get a Recommend rule. - Return a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/). + Required API Key ACLs: + - settings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param model: [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required) @@ -669,10 +665,11 @@ async def get_recommend_status_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get a Recommend task's status. - Some operations, such as deleting a Recommend rule, will respond with a `taskID` value. Use this value here to check the status of that task. + Required API Key ACLs: + - editSettings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param model: [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required) @@ -731,10 +728,11 @@ async def get_recommend_status( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetRecommendTaskResponse: """ - Get a Recommend task's status. - Some operations, such as deleting a Recommend rule, will respond with a `taskID` value. Use this value here to check the status of that task. + Required API Key ACLs: + - editSettings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param model: [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required) @@ -756,10 +754,11 @@ async def get_recommendations_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get recommendations and trending items. - Returns results from either recommendation or trending models: - **Recommendations** are provided by the [Related Products](https://www.algolia.com/doc/guides/algolia-recommend/overview/#related-products-and-related-content) and [Frequently Bought Together](https://www.algolia.com/doc/guides/algolia-recommend/overview/#frequently-bought-together) models - **Trending** models are [Trending Items and Trending Facet Values](https://www.algolia.com/doc/guides/algolia-recommend/overview/#trending-items-and-trending-facet-values). + Required API Key ACLs: + - search + :param get_recommendations_params: (required) :type get_recommendations_params: GetRecommendationsParams :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -791,10 +790,11 @@ async def get_recommendations( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetRecommendationsResponse: """ - Get recommendations and trending items. - Returns results from either recommendation or trending models: - **Recommendations** are provided by the [Related Products](https://www.algolia.com/doc/guides/algolia-recommend/overview/#related-products-and-related-content) and [Frequently Bought Together](https://www.algolia.com/doc/guides/algolia-recommend/overview/#frequently-bought-together) models - **Trending** models are [Trending Items and Trending Facet Values](https://www.algolia.com/doc/guides/algolia-recommend/overview/#trending-items-and-trending-facet-values). + Required API Key ACLs: + - search + :param get_recommendations_params: (required) :type get_recommendations_params: GetRecommendationsParams :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -821,10 +821,11 @@ async def search_recommend_rules_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - List Recommend rules. - List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/). + Required API Key ACLs: + - settings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param model: [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required) @@ -876,10 +877,11 @@ async def search_recommend_rules( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> SearchRecommendRulesResponse: """ - List Recommend rules. - List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/). + Required API Key ACLs: + - settings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param model: [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required) diff --git a/algoliasearch/search/client.py b/algoliasearch/search/client.py index 4bbbbd44d..20c6cc138 100644 --- a/algoliasearch/search/client.py +++ b/algoliasearch/search/client.py @@ -353,10 +353,11 @@ async def add_api_key_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Add API key. - Add a new API key with specific permissions and restrictions. The request must be authenticated with the admin API key. The response returns an API key string. + Required API Key ACLs: + - admin + :param api_key: (required) :type api_key: ApiKey :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -388,10 +389,11 @@ async def add_api_key( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> AddApiKeyResponse: """ - Add API key. - Add a new API key with specific permissions and restrictions. The request must be authenticated with the admin API key. The response returns an API key string. + Required API Key ACLs: + - admin + :param api_key: (required) :type api_key: ApiKey :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -413,10 +415,11 @@ async def add_or_update_object_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Add or update a record (using objectID). - If you use an existing `objectID`, the existing record will be replaced with the new one. To update only some attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add multiple records to your index in a single API request, use the [`batch` operation](#tag/Records/operation/batch). + Required API Key ACLs: + - addObject + :param index_name: Index on which to perform the request. (required) :type index_name: str :param object_id: Unique record (object) identifier. (required) @@ -470,10 +473,11 @@ async def add_or_update_object( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> UpdatedAtWithObjectIdResponse: """ - Add or update a record (using objectID). - If you use an existing `objectID`, the existing record will be replaced with the new one. To update only some attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add multiple records to your index in a single API request, use the [`batch` operation](#tag/Records/operation/batch). + Required API Key ACLs: + - addObject + :param index_name: Index on which to perform the request. (required) :type index_name: str :param object_id: Unique record (object) identifier. (required) @@ -495,10 +499,11 @@ async def append_source_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Add a source. - Add a source to the list of allowed sources. + Required API Key ACLs: + - admin + :param source: Source to add. (required) :type source: Source :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -530,10 +535,11 @@ async def append_source( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> CreatedAtResponse: """ - Add a source. - Add a source to the list of allowed sources. + Required API Key ACLs: + - admin + :param source: Source to add. (required) :type source: Source :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -552,10 +558,11 @@ async def assign_user_id_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Assign or move a user ID. - Assign or move a user ID to a cluster. The time it takes to move a user is proportional to the amount of data linked to the user ID. + Required API Key ACLs: + - admin + :param x_algolia_user_id: userID to assign. (required) :type x_algolia_user_id: str :param assign_user_id_params: (required) @@ -603,10 +610,11 @@ async def assign_user_id( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> CreatedAtResponse: """ - Assign or move a user ID. - Assign or move a user ID to a cluster. The time it takes to move a user is proportional to the amount of data linked to the user ID. + Required API Key ACLs: + - admin + :param x_algolia_user_id: userID to assign. (required) :type x_algolia_user_id: str :param assign_user_id_params: (required) @@ -629,10 +637,9 @@ async def batch_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Batch write operations on one index. - To reduce the time spent on network round trips, you can perform several write actions in a single API call. Actions are applied in the order they are specified. The supported `action`s are equivalent to the individual operations of the same name. + :param index_name: Index on which to perform the request. (required) :type index_name: str :param batch_write_params: (required) @@ -674,10 +681,9 @@ async def batch( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> BatchResponse: """ - Batch write operations on one index. - To reduce the time spent on network round trips, you can perform several write actions in a single API call. Actions are applied in the order they are specified. The supported `action`s are equivalent to the individual operations of the same name. + :param index_name: Index on which to perform the request. (required) :type index_name: str :param batch_write_params: (required) @@ -700,10 +706,11 @@ async def batch_assign_user_ids_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Batch assign userIDs. - Assign multiple user IDs to a cluster. **You can't _move_ users with this operation.**. + Required API Key ACLs: + - admin + :param x_algolia_user_id: userID to assign. (required) :type x_algolia_user_id: str :param batch_assign_user_ids_params: (required) @@ -751,10 +758,11 @@ async def batch_assign_user_ids( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> CreatedAtResponse: """ - Batch assign userIDs. - Assign multiple user IDs to a cluster. **You can't _move_ users with this operation.**. + Required API Key ACLs: + - admin + :param x_algolia_user_id: userID to assign. (required) :type x_algolia_user_id: str :param batch_assign_user_ids_params: (required) @@ -777,10 +785,11 @@ async def batch_dictionary_entries_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Batch dictionary entries. - Add or remove a batch of dictionary entries. + Required API Key ACLs: + - editSettings + :param dictionary_name: Dictionary to search in. (required) :type dictionary_name: DictionaryType :param batch_dictionary_entries_params: (required) @@ -824,10 +833,11 @@ async def batch_dictionary_entries( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> UpdatedAtResponse: """ - Batch dictionary entries. - Add or remove a batch of dictionary entries. + Required API Key ACLs: + - editSettings + :param dictionary_name: Dictionary to search in. (required) :type dictionary_name: DictionaryType :param batch_dictionary_entries_params: (required) @@ -850,10 +860,11 @@ async def browse_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get all records from an index. - Retrieve up to 1,000 records per call. Supports full-text search and filters. For better performance, it doesn't support: - The `distinct` query parameter - Sorting by typos, proximity, words, or geographical distance. + Required API Key ACLs: + - browse + :param index_name: Index on which to perform the request. (required) :type index_name: str :param browse_params: @@ -892,10 +903,11 @@ async def browse( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> BrowseResponse: """ - Get all records from an index. - Retrieve up to 1,000 records per call. Supports full-text search and filters. For better performance, it doesn't support: - The `distinct` query parameter - Sorting by typos, proximity, words, or geographical distance. + Required API Key ACLs: + - browse + :param index_name: Index on which to perform the request. (required) :type index_name: str :param browse_params: @@ -915,10 +927,11 @@ async def clear_objects_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Delete all records from an index. - Delete the records but leave settings and index-specific API keys untouched. + Required API Key ACLs: + - deleteIndex + :param index_name: Index on which to perform the request. (required) :type index_name: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -949,10 +962,11 @@ async def clear_objects( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> UpdatedAtResponse: """ - Delete all records from an index. - Delete the records but leave settings and index-specific API keys untouched. + Required API Key ACLs: + - deleteIndex + :param index_name: Index on which to perform the request. (required) :type index_name: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -976,10 +990,11 @@ async def clear_rules_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Delete all rules. - Delete all rules in the index. + Required API Key ACLs: + - editSettings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param forward_to_replicas: Indicates whether changed index settings are forwarded to the replica indices. @@ -1024,10 +1039,11 @@ async def clear_rules( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> UpdatedAtResponse: """ - Delete all rules. - Delete all rules in the index. + Required API Key ACLs: + - editSettings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param forward_to_replicas: Indicates whether changed index settings are forwarded to the replica indices. @@ -1055,10 +1071,11 @@ async def clear_synonyms_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Delete all synonyms. - Delete all synonyms in the index. + Required API Key ACLs: + - editSettings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param forward_to_replicas: Indicates whether changed index settings are forwarded to the replica indices. @@ -1103,10 +1120,11 @@ async def clear_synonyms( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> UpdatedAtResponse: """ - Delete all synonyms. - Delete all synonyms in the index. + Required API Key ACLs: + - editSettings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param forward_to_replicas: Indicates whether changed index settings are forwarded to the replica indices. @@ -1135,10 +1153,9 @@ async def custom_delete_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -1183,10 +1200,9 @@ async def custom_delete( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -1213,10 +1229,9 @@ async def custom_get_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -1259,10 +1274,9 @@ async def custom_get( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -1293,10 +1307,9 @@ async def custom_post_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -1350,10 +1363,9 @@ async def custom_post( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -1388,10 +1400,9 @@ async def custom_put_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -1445,10 +1456,9 @@ async def custom_put( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> object: """ - Send requests to the Algolia REST API. - This method allow you to send requests to the Algolia REST API. + :param path: Path of the endpoint, anything after \"/1\" must be specified. (required) :type path: str :param parameters: Query parameters to apply to the current query. @@ -1470,10 +1480,11 @@ async def delete_api_key_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Delete API key. - Delete an existing API key. The request must be authenticated with the admin API key. + Required API Key ACLs: + - admin + :param key: API key. (required) :type key: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1500,10 +1511,11 @@ async def delete_api_key( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> DeleteApiKeyResponse: """ - Delete API key. - Delete an existing API key. The request must be authenticated with the admin API key. + Required API Key ACLs: + - admin + :param key: API key. (required) :type key: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1522,10 +1534,11 @@ async def delete_by_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Delete all records matching a query. - This operation doesn't support all the query options, only its filters (numeric, facet, or tag) and geo queries. It doesn't accept empty filters or queries. + Required API Key ACLs: + - deleteIndex + :param index_name: Index on which to perform the request. (required) :type index_name: str :param delete_by_params: (required) @@ -1569,10 +1582,11 @@ async def delete_by( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> DeletedAtResponse: """ - Delete all records matching a query. - This operation doesn't support all the query options, only its filters (numeric, facet, or tag) and geo queries. It doesn't accept empty filters or queries. + Required API Key ACLs: + - deleteIndex + :param index_name: Index on which to perform the request. (required) :type index_name: str :param delete_by_params: (required) @@ -1594,10 +1608,11 @@ async def delete_index_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Delete index. - Delete an existing index. + Required API Key ACLs: + - deleteIndex + :param index_name: Index on which to perform the request. (required) :type index_name: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1628,10 +1643,11 @@ async def delete_index( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> DeletedAtResponse: """ - Delete index. - Delete an existing index. + Required API Key ACLs: + - deleteIndex + :param index_name: Index on which to perform the request. (required) :type index_name: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1652,10 +1668,11 @@ async def delete_object_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Delete a record. - To delete a set of records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy) instead. + Required API Key ACLs: + - deleteObject + :param index_name: Index on which to perform the request. (required) :type index_name: str :param object_id: Unique record (object) identifier. (required) @@ -1696,10 +1713,11 @@ async def delete_object( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> DeletedAtResponse: """ - Delete a record. - To delete a set of records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy) instead. + Required API Key ACLs: + - deleteObject + :param index_name: Index on which to perform the request. (required) :type index_name: str :param object_id: Unique record (object) identifier. (required) @@ -1730,10 +1748,11 @@ async def delete_rule_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Delete a rule. - Delete a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules). + Required API Key ACLs: + - editSettings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param object_id: Unique identifier of a rule object. (required) @@ -1788,10 +1807,11 @@ async def delete_rule( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> UpdatedAtResponse: """ - Delete a rule. - Delete a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules). + Required API Key ACLs: + - editSettings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param object_id: Unique identifier of a rule object. (required) @@ -1815,10 +1835,11 @@ async def delete_source_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Remove a source. - Remove a source from the list of allowed sources. + Required API Key ACLs: + - admin + :param source: IP address range of the source. (required) :type source: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1849,10 +1870,11 @@ async def delete_source( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> DeleteSourceResponse: """ - Remove a source. - Remove a source from the list of allowed sources. + Required API Key ACLs: + - admin + :param source: IP address range of the source. (required) :type source: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1879,10 +1901,11 @@ async def delete_synonym_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Delete a synonym. - Delete a synonym by its `objectID`. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). + Required API Key ACLs: + - editSettings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param object_id: Unique identifier of a synonym object. (required) @@ -1937,10 +1960,11 @@ async def delete_synonym( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> DeletedAtResponse: """ - Delete a synonym. - Delete a synonym by its `objectID`. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). + Required API Key ACLs: + - editSettings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param object_id: Unique identifier of a synonym object. (required) @@ -1962,10 +1986,9 @@ async def get_api_key_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get API key permissions. - Get the permissions and restrictions of a specific API key. When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key. + :param key: API key. (required) :type key: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1990,10 +2013,9 @@ async def get_api_key( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetApiKeyResponse: """ - Get API key permissions. - Get the permissions and restrictions of a specific API key. When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key. + :param key: API key. (required) :type key: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2007,10 +2029,11 @@ async def get_dictionary_languages_with_http_info( self, request_options: Optional[Union[dict, RequestOptions]] = None ) -> ApiResponse[str]: """ - List available languages. - Lists Algolia's [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and any customizations applied to each language's [stop word](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plural](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), and [segmentation (compound)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) features. + Required API Key ACLs: + - settings + :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) :return: Returns the raw algoliasearch 'APIResponse' object. """ @@ -2028,10 +2051,11 @@ async def get_dictionary_languages( self, request_options: Optional[Union[dict, RequestOptions]] = None ) -> Dict[str, Languages]: """ - List available languages. - Lists Algolia's [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and any customizations applied to each language's [stop word](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plural](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), and [segmentation (compound)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) features. + Required API Key ACLs: + - settings + :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) :return: Returns the deserialized response in a 'Dict[str, Languages]' result object. """ @@ -2043,10 +2067,11 @@ async def get_dictionary_settings_with_http_info( self, request_options: Optional[Union[dict, RequestOptions]] = None ) -> ApiResponse[str]: """ - Get stop word settings. - Get the languages for which [stop words are turned off](#tag/Dictionaries/operation/setDictionarySettings). + Required API Key ACLs: + - settings + :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) :return: Returns the raw algoliasearch 'APIResponse' object. """ @@ -2064,10 +2089,11 @@ async def get_dictionary_settings( self, request_options: Optional[Union[dict, RequestOptions]] = None ) -> GetDictionarySettingsResponse: """ - Get stop word settings. - Get the languages for which [stop words are turned off](#tag/Dictionaries/operation/setDictionarySettings). + Required API Key ACLs: + - settings + :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) :return: Returns the deserialized response in a 'GetDictionarySettingsResponse' result object. """ @@ -2102,10 +2128,11 @@ async def get_logs_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Return the latest log entries. - The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). Logs are held for the last seven days. There's also a logging limit of 1,000 API calls per server. This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself. > **Note**: To fetch the logs for a Distributed Search Network (DSN) cluster, target the [DSN's endpoint](https://www.algolia.com/doc/guides/scaling/distributed-search-network-dsn/#accessing-dsn-servers). + Required API Key ACLs: + - logs + :param offset: First log entry to retrieve. Sorted by decreasing date with 0 being the most recent. :type offset: int :param length: Maximum number of entries to retrieve. @@ -2166,10 +2193,11 @@ async def get_logs( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetLogsResponse: """ - Return the latest log entries. - The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). Logs are held for the last seven days. There's also a logging limit of 1,000 API calls per server. This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself. > **Note**: To fetch the logs for a Distributed Search Network (DSN) cluster, target the [DSN's endpoint](https://www.algolia.com/doc/guides/scaling/distributed-search-network-dsn/#accessing-dsn-servers). + Required API Key ACLs: + - logs + :param offset: First log entry to retrieve. Sorted by decreasing date with 0 being the most recent. :type offset: int :param length: Maximum number of entries to retrieve. @@ -2204,10 +2232,11 @@ async def get_object_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get a record. - To get more than one record, use the [`objects` operation](#tag/Records/operation/getObjects). + Required API Key ACLs: + - search + :param index_name: Index on which to perform the request. (required) :type index_name: str :param object_id: Unique record (object) identifier. (required) @@ -2262,10 +2291,11 @@ async def get_object( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> Dict[str, str]: """ - Get a record. - To get more than one record, use the [`objects` operation](#tag/Records/operation/getObjects). + Required API Key ACLs: + - search + :param index_name: Index on which to perform the request. (required) :type index_name: str :param object_id: Unique record (object) identifier. (required) @@ -2289,10 +2319,11 @@ async def get_objects_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get multiple records. - Retrieve one or more records, potentially from different indices, in a single API operation. Results will be received in the same order as the requests. + Required API Key ACLs: + - search + :param get_objects_params: Request object. (required) :type get_objects_params: GetObjectsParams :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2326,10 +2357,11 @@ async def get_objects( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetObjectsResponse: """ - Get multiple records. - Retrieve one or more records, potentially from different indices, in a single API operation. Results will be received in the same order as the requests. + Required API Key ACLs: + - search + :param get_objects_params: Request object. (required) :type get_objects_params: GetObjectsParams :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2350,10 +2382,11 @@ async def get_rule_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get a rule. - Get a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules). + Required API Key ACLs: + - settings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param object_id: Unique identifier of a rule object. (required) @@ -2394,10 +2427,11 @@ async def get_rule( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> Rule: """ - Get a rule. - Get a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules). + Required API Key ACLs: + - settings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param object_id: Unique identifier of a rule object. (required) @@ -2417,10 +2451,11 @@ async def get_settings_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get index settings. - Return an object containing an index's [configuration settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/). + Required API Key ACLs: + - search + :param index_name: Index on which to perform the request. (required) :type index_name: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2451,10 +2486,11 @@ async def get_settings( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> IndexSettings: """ - Get index settings. - Return an object containing an index's [configuration settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/). + Required API Key ACLs: + - search + :param index_name: Index on which to perform the request. (required) :type index_name: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2468,10 +2504,11 @@ async def get_sources_with_http_info( self, request_options: Optional[Union[dict, RequestOptions]] = None ) -> ApiResponse[str]: """ - Get all allowed IP addresses. - Get all allowed sources (IP addresses). + Required API Key ACLs: + - admin + :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) :return: Returns the raw algoliasearch 'APIResponse' object. """ @@ -2489,10 +2526,11 @@ async def get_sources( self, request_options: Optional[Union[dict, RequestOptions]] = None ) -> List[Source]: """ - Get all allowed IP addresses. - Get all allowed sources (IP addresses). + Required API Key ACLs: + - admin + :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) :return: Returns the deserialized response in a 'List[Source]' result object. """ @@ -2511,10 +2549,11 @@ async def get_synonym_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get a synonym object. - Get a syonym by its `objectID`. To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). + Required API Key ACLs: + - settings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param object_id: Unique identifier of a synonym object. (required) @@ -2555,10 +2594,11 @@ async def get_synonym( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> SynonymHit: """ - Get a synonym object. - Get a syonym by its `objectID`. To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). + Required API Key ACLs: + - settings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param object_id: Unique identifier of a synonym object. (required) @@ -2581,10 +2621,11 @@ async def get_task_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Check a task's status. - Some operations, such as copying an index, will respond with a `taskID` value. Use this value here to check the status of that task. + Required API Key ACLs: + - addObject + :param index_name: Index on which to perform the request. (required) :type index_name: str :param task_id: Unique task identifier. (required) @@ -2621,10 +2662,11 @@ async def get_task( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> GetTaskResponse: """ - Check a task's status. - Some operations, such as copying an index, will respond with a `taskID` value. Use this value here to check the status of that task. + Required API Key ACLs: + - addObject + :param index_name: Index on which to perform the request. (required) :type index_name: str :param task_id: Unique task identifier. (required) @@ -2640,10 +2682,11 @@ async def get_top_user_ids_with_http_info( self, request_options: Optional[Union[dict, RequestOptions]] = None ) -> ApiResponse[str]: """ - Get top userID. - Get the IDs of the 10 users with the highest number of records per cluster. Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time. + Required API Key ACLs: + - admin + :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) :return: Returns the raw algoliasearch 'APIResponse' object. """ @@ -2661,10 +2704,11 @@ async def get_top_user_ids( self, request_options: Optional[Union[dict, RequestOptions]] = None ) -> GetTopUserIdsResponse: """ - Get top userID. - Get the IDs of the 10 users with the highest number of records per cluster. Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time. + Required API Key ACLs: + - admin + :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) :return: Returns the deserialized response in a 'GetTopUserIdsResponse' result object. """ @@ -2678,10 +2722,11 @@ async def get_user_id_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get userID. - Returns the userID data stored in the mapping. Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time. + Required API Key ACLs: + - admin + :param user_id: userID to assign. (required) :type user_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2710,10 +2755,11 @@ async def get_user_id( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> UserId: """ - Get userID. - Returns the userID data stored in the mapping. Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time. + Required API Key ACLs: + - admin + :param user_id: userID to assign. (required) :type user_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2734,10 +2780,11 @@ async def has_pending_mappings_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Get migration and user mapping status. - To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process. + Required API Key ACLs: + - admin + :param get_clusters: Indicates whether to include the cluster's pending mapping state in the response. :type get_clusters: bool :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2770,10 +2817,11 @@ async def has_pending_mappings( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> HasPendingMappingsResponse: """ - Get migration and user mapping status. - To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process. + Required API Key ACLs: + - admin + :param get_clusters: Indicates whether to include the cluster's pending mapping state in the response. :type get_clusters: bool :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -2789,10 +2837,11 @@ async def list_api_keys_with_http_info( self, request_options: Optional[Union[dict, RequestOptions]] = None ) -> ApiResponse[str]: """ - List API keys. - List all API keys associated with your Algolia application, including their permissions and restrictions. + Required API Key ACLs: + - admin + :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) :return: Returns the raw algoliasearch 'APIResponse' object. """ @@ -2810,10 +2859,11 @@ async def list_api_keys( self, request_options: Optional[Union[dict, RequestOptions]] = None ) -> ListApiKeysResponse: """ - List API keys. - List all API keys associated with your Algolia application, including their permissions and restrictions. + Required API Key ACLs: + - admin + :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) :return: Returns the deserialized response in a 'ListApiKeysResponse' result object. """ @@ -2825,10 +2875,11 @@ async def list_clusters_with_http_info( self, request_options: Optional[Union[dict, RequestOptions]] = None ) -> ApiResponse[str]: """ - List clusters. - List the available clusters in a multi-cluster setup. + Required API Key ACLs: + - admin + :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) :return: Returns the raw algoliasearch 'APIResponse' object. """ @@ -2846,10 +2897,11 @@ async def list_clusters( self, request_options: Optional[Union[dict, RequestOptions]] = None ) -> ListClustersResponse: """ - List clusters. - List the available clusters in a multi-cluster setup. + Required API Key ACLs: + - admin + :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) :return: Returns the deserialized response in a 'ListClustersResponse' result object. """ @@ -2871,10 +2923,11 @@ async def list_indices_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - List indices. - List indices in an Algolia application. + Required API Key ACLs: + - listIndexes + :param page: Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated. :type page: int :param hits_per_page: Maximum number of hits per page. @@ -2914,10 +2967,11 @@ async def list_indices( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ListIndicesResponse: """ - List indices. - List indices in an Algolia application. + Required API Key ACLs: + - listIndexes + :param page: Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated. :type page: int :param hits_per_page: Maximum number of hits per page. @@ -2943,10 +2997,11 @@ async def list_user_ids_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - List userIDs. - List the userIDs assigned to a multi-cluster application. Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time. + Required API Key ACLs: + - admin + :param page: Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated. :type page: int :param hits_per_page: Maximum number of hits per page. @@ -2986,10 +3041,11 @@ async def list_user_ids( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ListUserIdsResponse: """ - List userIDs. - List the userIDs assigned to a multi-cluster application. Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time. + Required API Key ACLs: + - admin + :param page: Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated. :type page: int :param hits_per_page: Maximum number of hits per page. @@ -3009,10 +3065,9 @@ async def multiple_batch_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Batch write operations on multiple indices. - To reduce the time spent on network round trips, you can perform several write actions in a single request. It's a multi-index version of the [`batch` operation](#tag/Records/operation/batch). Actions are applied in the order they are specified. The supported actions are equivalent to the individual operations of the same name. + :param batch_params: (required) :type batch_params: BatchParams :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -3044,10 +3099,9 @@ async def multiple_batch( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> MultipleBatchResponse: """ - Batch write operations on multiple indices. - To reduce the time spent on network round trips, you can perform several write actions in a single request. It's a multi-index version of the [`batch` operation](#tag/Records/operation/batch). Actions are applied in the order they are specified. The supported actions are equivalent to the individual operations of the same name. + :param batch_params: (required) :type batch_params: BatchParams :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -3066,10 +3120,11 @@ async def operation_index_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Copy, move, or rename an index. - This `operation`, _copy_ or _move_, will copy or move a source index's (`IndexName`) records, settings, synonyms, and rules to a `destination` index. If the destination index exists, it will be replaced, except for index-specific API keys and analytics data. If the destination index doesn't exist, it will be created. The choice between moving or copying an index depends on your needs. Choose: - **Move** to rename an index. - **Copy** to create a new index with the same records and configuration as an existing one. > **Note**: When considering copying or moving, be aware of the [rate limitations](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits) on these processes and the [impact on your analytics data](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/concepts/indices-analytics/). + Required API Key ACLs: + - addObject + :param index_name: Index on which to perform the request. (required) :type index_name: str :param operation_index_params: (required) @@ -3113,10 +3168,11 @@ async def operation_index( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> UpdatedAtResponse: """ - Copy, move, or rename an index. - This `operation`, _copy_ or _move_, will copy or move a source index's (`IndexName`) records, settings, synonyms, and rules to a `destination` index. If the destination index exists, it will be replaced, except for index-specific API keys and analytics data. If the destination index doesn't exist, it will be created. The choice between moving or copying an index depends on your needs. Choose: - **Move** to rename an index. - **Copy** to create a new index with the same records and configuration as an existing one. > **Note**: When considering copying or moving, be aware of the [rate limitations](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits) on these processes and the [impact on your analytics data](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/concepts/indices-analytics/). + Required API Key ACLs: + - addObject + :param index_name: Index on which to perform the request. (required) :type index_name: str :param operation_index_params: (required) @@ -3151,10 +3207,11 @@ async def partial_update_object_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Update record attributes. - Add new attributes or update current ones in an existing record. You can use any first-level attribute but not nested attributes. If you specify a [nested attribute](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/creating-and-using-nested-attributes/), the engine treats it as a replacement for its first-level ancestor. + Required API Key ACLs: + - addObject + :param index_name: Index on which to perform the request. (required) :type index_name: str :param object_id: Unique record (object) identifier. (required) @@ -3225,10 +3282,11 @@ async def partial_update_object( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> UpdatedAtWithObjectIdResponse: """ - Update record attributes. - Add new attributes or update current ones in an existing record. You can use any first-level attribute but not nested attributes. If you specify a [nested attribute](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/creating-and-using-nested-attributes/), the engine treats it as a replacement for its first-level ancestor. + Required API Key ACLs: + - addObject + :param index_name: Index on which to perform the request. (required) :type index_name: str :param object_id: Unique record (object) identifier. (required) @@ -3256,10 +3314,11 @@ async def remove_user_id_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Remove userID. - Remove a userID and its associated data from the multi-clusters. + Required API Key ACLs: + - admin + :param user_id: userID to assign. (required) :type user_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -3288,10 +3347,11 @@ async def remove_user_id( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> RemoveUserIdResponse: """ - Remove userID. - Remove a userID and its associated data from the multi-clusters. + Required API Key ACLs: + - admin + :param user_id: userID to assign. (required) :type user_id: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -3307,10 +3367,11 @@ async def replace_sources_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Replace all sources. - Replace all allowed sources. + Required API Key ACLs: + - admin + :param source: Allowed sources. (required) :type source: List[Source] :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -3342,10 +3403,11 @@ async def replace_sources( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ReplaceSourceResponse: """ - Replace all sources. - Replace all allowed sources. + Required API Key ACLs: + - admin + :param source: Allowed sources. (required) :type source: List[Source] :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -3361,10 +3423,11 @@ async def restore_api_key_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Restore API key. - Restore a deleted API key, along with its associated permissions. The request must be authenticated with the admin API key. + Required API Key ACLs: + - admin + :param key: API key. (required) :type key: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -3391,10 +3454,11 @@ async def restore_api_key( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> AddApiKeyResponse: """ - Restore API key. - Restore a deleted API key, along with its associated permissions. The request must be authenticated with the admin API key. + Required API Key ACLs: + - admin + :param key: API key. (required) :type key: str :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -3413,10 +3477,11 @@ async def save_object_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Add or update a record. - Add a record (object) to an index or replace it. If the record doesn't contain an `objectID`, Algolia automatically adds it. If you use an existing `objectID`, the existing record is replaced with the new one. To add multiple records to your index in a single API request, use the [`batch` operation](#tag/Records/operation/batch). + Required API Key ACLs: + - addObject + :param index_name: Index on which to perform the request. (required) :type index_name: str :param body: The Algolia record. (required) @@ -3458,10 +3523,11 @@ async def save_object( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> SaveObjectResponse: """ - Add or update a record. - Add a record (object) to an index or replace it. If the record doesn't contain an `objectID`, Algolia automatically adds it. If you use an existing `objectID`, the existing record is replaced with the new one. To add multiple records to your index in a single API request, use the [`batch` operation](#tag/Records/operation/batch). + Required API Key ACLs: + - addObject + :param index_name: Index on which to perform the request. (required) :type index_name: str :param body: The Algolia record. (required) @@ -3491,10 +3557,11 @@ async def save_rule_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Create or update a rule. - To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules). + Required API Key ACLs: + - editSettings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param object_id: Unique identifier of a rule object. (required) @@ -3560,10 +3627,11 @@ async def save_rule( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> UpdatedRuleResponse: """ - Create or update a rule. - To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules). + Required API Key ACLs: + - editSettings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param object_id: Unique identifier of a rule object. (required) @@ -3602,10 +3670,11 @@ async def save_rules_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Save a batch of rules. - Create or update multiple rules. + Required API Key ACLs: + - editSettings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param rules: (required) @@ -3671,10 +3740,11 @@ async def save_rules( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> UpdatedAtResponse: """ - Save a batch of rules. - Create or update multiple rules. + Required API Key ACLs: + - editSettings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param rules: (required) @@ -3714,10 +3784,11 @@ async def save_synonym_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Save a synonym. - Add a [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) to an index or replace it. If the synonym `objectID` doesn't exist, Algolia adds a new one. If you use an existing synonym `objectID`, the existing synonym is replaced with the new one. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms). + Required API Key ACLs: + - editSettings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param object_id: Unique identifier of a synonym object. (required) @@ -3785,10 +3856,11 @@ async def save_synonym( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> SaveSynonymResponse: """ - Save a synonym. - Add a [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) to an index or replace it. If the synonym `objectID` doesn't exist, Algolia adds a new one. If you use an existing synonym `objectID`, the existing synonym is replaced with the new one. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms). + Required API Key ACLs: + - editSettings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param object_id: Unique identifier of a synonym object. (required) @@ -3827,10 +3899,11 @@ async def save_synonyms_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Save a batch of synonyms. - Create or update multiple synonyms. + Required API Key ACLs: + - editSettings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param synonym_hit: (required) @@ -3900,10 +3973,11 @@ async def save_synonyms( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> UpdatedAtResponse: """ - Save a batch of synonyms. - Create or update multiple synonyms. + Required API Key ACLs: + - editSettings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param synonym_hit: (required) @@ -3936,10 +4010,11 @@ async def search_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Search multiple indices. - Send multiple search queries to one or more indices. + Required API Key ACLs: + - search + :param search_method_params: Query requests and strategies. Results will be received in the same order as the queries. (required) :type search_method_params: SearchMethodParams :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -3976,10 +4051,11 @@ async def search( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> SearchResponses: """ - Search multiple indices. - Send multiple search queries to one or more indices. + Required API Key ACLs: + - search + :param search_method_params: Query requests and strategies. Results will be received in the same order as the queries. (required) :type search_method_params: SearchMethodParams :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -3998,10 +4074,11 @@ async def search_dictionary_entries_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Search dictionary entries. - Search for standard and [custom](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/) entries in the [stop words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plurals](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), or [segmentation (compounds)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) dictionaries. + Required API Key ACLs: + - settings + :param dictionary_name: Dictionary to search in. (required) :type dictionary_name: DictionaryType :param search_dictionary_entries_params: (required) @@ -4045,10 +4122,11 @@ async def search_dictionary_entries( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> UpdatedAtResponse: """ - Search dictionary entries. - Search for standard and [custom](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/) entries in the [stop words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plurals](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), or [segmentation (compounds)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) dictionaries. + Required API Key ACLs: + - settings + :param dictionary_name: Dictionary to search in. (required) :type dictionary_name: DictionaryType :param search_dictionary_entries_params: (required) @@ -4072,10 +4150,11 @@ async def search_for_facet_values_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Search for facet values. - [Search for a facet's values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), optionally restricting the returned values to those contained in records matching other search criteria. > **Note**: Pagination isn't supported (`page` and `hitsPerPage` are ignored). By default, the engine returns a maximum of 10 values but you can adjust this with `maxFacetHits`. + Required API Key ACLs: + - search + :param index_name: Index on which to perform the request. (required) :type index_name: str :param facet_name: Facet name. (required) @@ -4122,10 +4201,11 @@ async def search_for_facet_values( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> SearchForFacetValuesResponse: """ - Search for facet values. - [Search for a facet's values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), optionally restricting the returned values to those contained in records matching other search criteria. > **Note**: Pagination isn't supported (`page` and `hitsPerPage` are ignored). By default, the engine returns a maximum of 10 values but you can adjust this with `maxFacetHits`. + Required API Key ACLs: + - search + :param index_name: Index on which to perform the request. (required) :type index_name: str :param facet_name: Facet name. (required) @@ -4150,10 +4230,11 @@ async def search_rules_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Search for rules. - Search for rules in your index. You can control the search with parameters. To list all rules, send an empty request body. + Required API Key ACLs: + - settings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param search_rules_params: @@ -4192,10 +4273,11 @@ async def search_rules( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> SearchRulesResponse: """ - Search for rules. - Search for rules in your index. You can control the search with parameters. To list all rules, send an empty request body. + Required API Key ACLs: + - settings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param search_rules_params: @@ -4218,10 +4300,11 @@ async def search_single_index_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Search an index. - Return records that match the query. + Required API Key ACLs: + - search + :param index_name: Index on which to perform the request. (required) :type index_name: str :param search_params: @@ -4260,10 +4343,11 @@ async def search_single_index( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> SearchResponse: """ - Search an index. - Return records that match the query. + Required API Key ACLs: + - search + :param index_name: Index on which to perform the request. (required) :type index_name: str :param search_params: @@ -4289,10 +4373,11 @@ async def search_synonyms_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Search for synonyms. - Search for synonyms in your index. You can control and filter the search with parameters. To get all synonyms, send an empty request body. + Required API Key ACLs: + - settings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param search_synonyms_params: Body of the `searchSynonyms` operation. @@ -4334,10 +4419,11 @@ async def search_synonyms( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> SearchSynonymsResponse: """ - Search for synonyms. - Search for synonyms in your index. You can control and filter the search with parameters. To get all synonyms, send an empty request body. + Required API Key ACLs: + - settings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param search_synonyms_params: Body of the `searchSynonyms` operation. @@ -4357,10 +4443,11 @@ async def search_user_ids_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Search for a user ID. - Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time. To ensure rapid updates, the user IDs index isn't built at the same time as the mapping. Instead, it's built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours). + Required API Key ACLs: + - admin + :param search_user_ids_params: (required) :type search_user_ids_params: SearchUserIdsParams :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -4392,10 +4479,11 @@ async def search_user_ids( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> SearchUserIdsResponse: """ - Search for a user ID. - Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time. To ensure rapid updates, the user IDs index isn't built at the same time as the mapping. Instead, it's built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours). + Required API Key ACLs: + - admin + :param search_user_ids_params: (required) :type search_user_ids_params: SearchUserIdsParams :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -4413,10 +4501,11 @@ async def set_dictionary_settings_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Set stop word settings. - Set stop word settings for a specific language. + Required API Key ACLs: + - editSettings + :param dictionary_settings_params: (required) :type dictionary_settings_params: DictionarySettingsParams :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -4448,10 +4537,11 @@ async def set_dictionary_settings( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> UpdatedAtResponse: """ - Set stop word settings. - Set stop word settings for a specific language. + Required API Key ACLs: + - editSettings + :param dictionary_settings_params: (required) :type dictionary_settings_params: DictionarySettingsParams :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -4478,10 +4568,11 @@ async def set_settings_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Update index settings. - Update the specified [index settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/). Specifying null for a setting resets it to its default value. + Required API Key ACLs: + - editSettings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param index_settings: (required) @@ -4539,10 +4630,11 @@ async def set_settings( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> UpdatedAtResponse: """ - Update index settings. - Update the specified [index settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/). Specifying null for a setting resets it to its default value. + Required API Key ACLs: + - editSettings + :param index_name: Index on which to perform the request. (required) :type index_name: str :param index_settings: (required) @@ -4565,10 +4657,11 @@ async def update_api_key_with_http_info( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> ApiResponse[str]: """ - Update an API key. - Replace the permissions of an existing API key. Any unspecified parameter resets that permission to its default value. The request must be authenticated with the admin API key. + Required API Key ACLs: + - admin + :param key: API key. (required) :type key: str :param api_key: (required) @@ -4608,10 +4701,11 @@ async def update_api_key( request_options: Optional[Union[dict, RequestOptions]] = None, ) -> UpdateApiKeyResponse: """ - Update an API key. - Replace the permissions of an existing API key. Any unspecified parameter resets that permission to its default value. The request must be authenticated with the admin API key. + Required API Key ACLs: + - admin + :param key: API key. (required) :type key: str :param api_key: (required)