chore: deprecate mcm methods (generated)

algolia/api-clients-automation#4694

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Kai Welke <[email protected]>
Co-authored-by: shortcuts <[email protected]>

Author: 3 people

lib/algolia/api/ingestion_client.rb

@@ -261,6 +261,7 @@ def create_task(task_create, request_options = {})
 
     # Creates a new task using the v1 endpoint, please use `createTask` instead.
 
+    # THIS OPERATION IS DEPRECATED
     # @param task_create [TaskCreateV1] Request body for creating a task. (required)
     # @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 [Http::Response] the response
@@ -710,6 +711,7 @@ def delete_task(task_id, request_options = {})
 
     # Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
 
+    # THIS OPERATION IS DEPRECATED
     # @param task_id [String] Unique identifier of a task. (required)
     # @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 [Http::Response] the response
@@ -845,6 +847,7 @@ def disable_task(task_id, request_options = {})
     #   - addObject
     #   - deleteIndex
     #   - editSettings
+    # THIS OPERATION IS DEPRECATED
     # @param task_id [String] Unique identifier of a task. (required)
     # @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 [Http::Response] the response
@@ -941,6 +944,7 @@ def enable_task(task_id, request_options = {})
     #   - addObject
     #   - deleteIndex
     #   - editSettings
+    # THIS OPERATION IS DEPRECATED
     # @param task_id [String] Unique identifier of a task. (required)
     # @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 [Http::Response] the response
@@ -1292,6 +1296,7 @@ def get_task(task_id, request_options = {})
     #   - addObject
     #   - deleteIndex
     #   - editSettings
+    # THIS OPERATION IS DEPRECATED
     # @param task_id [String] Unique identifier of a task. (required)
     # @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 [Http::Response] the response
@@ -1972,6 +1977,7 @@ def list_tasks(
     #   - addObject
     #   - deleteIndex
     #   - editSettings
+    # THIS OPERATION IS DEPRECATED
     # @param items_per_page [Integer] Number of items per page. (default to 10)
     # @param page [Integer] Page number of the paginated API response.
     # @param action [Array<ActionType>] Actions for filtering the list of tasks.
@@ -2295,6 +2301,7 @@ def run_task(task_id, request_options = {})
     #   - addObject
     #   - deleteIndex
     #   - editSettings
+    # THIS OPERATION IS DEPRECATED
     # @param task_id [String] Unique identifier of a task. (required)
     # @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 [Http::Response] the response
@@ -2535,6 +2542,7 @@ def search_tasks(task_search, request_options = {})
     #   - addObject
     #   - deleteIndex
     #   - editSettings
+    # THIS OPERATION IS DEPRECATED
     # @param task_search [TaskSearch]  (required)
     # @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 [Http::Response] the response
@@ -3014,6 +3022,7 @@ def update_task(task_id, task_update, request_options = {})
 
     # Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
 
+    # THIS OPERATION IS DEPRECATED
     # @param task_id [String] Unique identifier of a task. (required)
     # @param task_update [TaskUpdateV1]  (required)
     # @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)

lib/algolia/api/search_client.rb

@@ -207,6 +207,7 @@ def append_source(source, request_options = {})
     #
     # Required API Key ACLs:
     #   - admin
+    # THIS OPERATION IS DEPRECATED
     # @param x_algolia_user_id [String] Unique identifier of the user who makes the search request. (required)
     # @param assign_user_id_params [AssignUserIdParams]  (required)
     # @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)
@@ -304,6 +305,7 @@ def batch(index_name, batch_write_params, request_options = {})
     #
     # Required API Key ACLs:
     #   - admin
+    # THIS OPERATION IS DEPRECATED
     # @param x_algolia_user_id [String] Unique identifier of the user who makes the search request. (required)
     # @param batch_assign_user_ids_params [BatchAssignUserIdsParams]  (required)
     # @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)
@@ -1673,6 +1675,7 @@ def get_task(index_name, task_id, request_options = {})
     #
     # Required API Key ACLs:
     #   - admin
+    # THIS OPERATION IS DEPRECATED
     # @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 [Http::Response] the response
     def get_top_user_ids_with_http_info(request_options = {})
@@ -1710,6 +1713,7 @@ def get_top_user_ids(request_options = {})
     #
     # Required API Key ACLs:
     #   - admin
+    # THIS OPERATION IS DEPRECATED
     # @param user_id [String] Unique identifier of the user who makes the search request. (required)
     # @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 [Http::Response] the response
@@ -1754,6 +1758,7 @@ def get_user_id(user_id, request_options = {})
     #
     # Required API Key ACLs:
     #   - admin
+    # THIS OPERATION IS DEPRECATED
     # @param get_clusters [Boolean] Whether to include the cluster's pending mapping state in the response.
     # @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 [Http::Response] the response
@@ -1834,6 +1839,7 @@ def list_api_keys(request_options = {})
     #
     # Required API Key ACLs:
     #   - admin
+    # THIS OPERATION IS DEPRECATED
     # @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 [Http::Response] the response
     def list_clusters_with_http_info(request_options = {})
@@ -1914,6 +1920,7 @@ def list_indices(page = nil, hits_per_page = nil, request_options = {})
     #
     # Required API Key ACLs:
     #   - admin
+    # THIS OPERATION IS DEPRECATED
     # @param page [Integer] Requested page of the API response. If `null`, the API response is not paginated.
     # @param hits_per_page [Integer] Number of hits per page. (default to 100)
     # @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)
@@ -2129,6 +2136,7 @@ def partial_update_object(
     #
     # Required API Key ACLs:
     #   - admin
+    # THIS OPERATION IS DEPRECATED
     # @param user_id [String] Unique identifier of the user who makes the search request. (required)
     # @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 [Http::Response] the response
@@ -2906,6 +2914,7 @@ def search_synonyms(index_name, search_synonyms_params = nil, request_options =
     #
     # Required API Key ACLs:
     #   - admin
+    # THIS OPERATION IS DEPRECATED
     # @param search_user_ids_params [SearchUserIdsParams]  (required)
     # @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 [Http::Response] the response