fix(specs): deprecate task v1 [skip-bc] (generated)

algolia/api-clients-automation#4327 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia · Jan 13, 2025 · 9709609 · 9709609
1 parent 0554e3c
commit 9709609
Showing 1 changed file with 64 additions and 0 deletions.
diff --git a/algoliasearch/ingestion/client.py b/algoliasearch/ingestion/client.py
@@ -466,6 +466,7 @@ async def create_task_v1_with_http_info(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
+        (Deprecated) create_task_v1
         Creates a new task using the v1 endpoint, please use `createTask` instead.
 
 
@@ -475,6 +476,8 @@ async def create_task_v1_with_http_info(
         :return: Returns the raw algoliasearch 'APIResponse' object.
         """
 
+        warn("POST /1/tasks is deprecated.", DeprecationWarning)
+
         if task_create is None:
             raise ValueError(
                 "Parameter `task_create` is required when calling `create_task_v1`."
@@ -505,6 +508,7 @@ async def create_task_v1(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> TaskCreateResponse:
         """
+        (Deprecated) create_task_v1
         Creates a new task using the v1 endpoint, please use `createTask` instead.
 
 
@@ -1159,6 +1163,7 @@ async def delete_task_v1_with_http_info(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
+        (Deprecated) delete_task_v1
         Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
 
 
@@ -1168,6 +1173,8 @@ async def delete_task_v1_with_http_info(
         :return: Returns the raw algoliasearch 'APIResponse' object.
         """
 
+        warn("DELETE /1/tasks/{taskID} is deprecated.", DeprecationWarning)
+
         if task_id is None:
             raise ValueError(
                 "Parameter `task_id` is required when calling `delete_task_v1`."
@@ -1190,6 +1197,7 @@ async def delete_task_v1(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> DeleteResponse:
         """
+        (Deprecated) delete_task_v1
         Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
 
 
@@ -1447,6 +1455,7 @@ async def enable_task_v1_with_http_info(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
+        (Deprecated) enable_task_v1
         Enables a task using the v1 endpoint, please use `enableTask` instead.
 
         Required API Key ACLs:
@@ -1460,6 +1469,8 @@ async def enable_task_v1_with_http_info(
         :return: Returns the raw algoliasearch 'APIResponse' object.
         """
 
+        warn("PUT /1/tasks/{taskID}/enable is deprecated.", DeprecationWarning)
+
         if task_id is None:
             raise ValueError(
                 "Parameter `task_id` is required when calling `enable_task_v1`."
@@ -1484,6 +1495,7 @@ async def enable_task_v1(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> TaskUpdateResponse:
         """
+        (Deprecated) enable_task_v1
         Enables a task using the v1 endpoint, please use `enableTask` instead.
 
         Required API Key ACLs:
@@ -1878,6 +1890,7 @@ async def get_task_v1_with_http_info(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
+        (Deprecated) get_task_v1
         Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
 
         Required API Key ACLs:
@@ -1891,6 +1904,8 @@ async def get_task_v1_with_http_info(
         :return: Returns the raw algoliasearch 'APIResponse' object.
         """
 
+        warn("GET /1/tasks/{taskID} is deprecated.", DeprecationWarning)
+
         if task_id is None:
             raise ValueError(
                 "Parameter `task_id` is required when calling `get_task_v1`."
@@ -1913,6 +1928,7 @@ async def get_task_v1(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> TaskV1:
         """
+        (Deprecated) get_task_v1
         Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
 
         Required API Key ACLs:
@@ -3186,6 +3202,7 @@ async def list_tasks_v1_with_http_info(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
+        (Deprecated) list_tasks_v1
         Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
 
         Required API Key ACLs:
@@ -3215,6 +3232,8 @@ async def list_tasks_v1_with_http_info(
         :return: Returns the raw algoliasearch 'APIResponse' object.
         """
 
+        warn("GET /1/tasks is deprecated.", DeprecationWarning)
+
         _query_parameters: Dict[str, Any] = {}
 
         if items_per_page is not None:
@@ -3297,6 +3316,7 @@ async def list_tasks_v1(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ListTasksResponseV1:
         """
+        (Deprecated) list_tasks_v1
         Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
 
         Required API Key ACLs:
@@ -3724,6 +3744,7 @@ async def run_task_v1_with_http_info(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
+        (Deprecated) run_task_v1
         Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
 
         Required API Key ACLs:
@@ -3737,6 +3758,8 @@ async def run_task_v1_with_http_info(
         :return: Returns the raw algoliasearch 'APIResponse' object.
         """
 
+        warn("POST /1/tasks/{taskID}/run is deprecated.", DeprecationWarning)
+
         if task_id is None:
             raise ValueError(
                 "Parameter `task_id` is required when calling `run_task_v1`."
@@ -3761,6 +3784,7 @@ async def run_task_v1(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> RunResponse:
         """
+        (Deprecated) run_task_v1
         Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
 
         Required API Key ACLs:
@@ -4022,6 +4046,7 @@ async def search_tasks_v1_with_http_info(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
+        (Deprecated) search_tasks_v1
         Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
 
         Required API Key ACLs:
@@ -4035,6 +4060,8 @@ async def search_tasks_v1_with_http_info(
         :return: Returns the raw algoliasearch 'APIResponse' object.
         """
 
+        warn("POST /1/tasks/search is deprecated.", DeprecationWarning)
+
         if task_search is None:
             raise ValueError(
                 "Parameter `task_search` is required when calling `search_tasks_v1`."
@@ -4060,6 +4087,7 @@ async def search_tasks_v1(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> List[TaskV1]:
         """
+        (Deprecated) search_tasks_v1
         Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
 
         Required API Key ACLs:
@@ -4655,6 +4683,7 @@ async def update_task_v1_with_http_info(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
+        (Deprecated) update_task_v1
         Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
 
 
@@ -4666,6 +4695,8 @@ async def update_task_v1_with_http_info(
         :return: Returns the raw algoliasearch 'APIResponse' object.
         """
 
+        warn("PATCH /1/tasks/{taskID} is deprecated.", DeprecationWarning)
+
         if task_id is None:
             raise ValueError(
                 "Parameter `task_id` is required when calling `update_task_v1`."
@@ -4699,6 +4730,7 @@ async def update_task_v1(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> TaskUpdateResponse:
         """
+        (Deprecated) update_task_v1
         Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
 
 
@@ -5270,6 +5302,7 @@ def create_task_v1_with_http_info(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
+        (Deprecated) create_task_v1
         Creates a new task using the v1 endpoint, please use `createTask` instead.
 
 
@@ -5279,6 +5312,8 @@ def create_task_v1_with_http_info(
         :return: Returns the raw algoliasearch 'APIResponse' object.
         """
 
+        warn("POST /1/tasks is deprecated.", DeprecationWarning)
+
         if task_create is None:
             raise ValueError(
                 "Parameter `task_create` is required when calling `create_task_v1`."
@@ -5309,6 +5344,7 @@ def create_task_v1(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> TaskCreateResponse:
         """
+        (Deprecated) create_task_v1
         Creates a new task using the v1 endpoint, please use `createTask` instead.
 
 
@@ -5955,6 +5991,7 @@ def delete_task_v1_with_http_info(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
+        (Deprecated) delete_task_v1
         Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
 
 
@@ -5964,6 +6001,8 @@ def delete_task_v1_with_http_info(
         :return: Returns the raw algoliasearch 'APIResponse' object.
         """
 
+        warn("DELETE /1/tasks/{taskID} is deprecated.", DeprecationWarning)
+
         if task_id is None:
             raise ValueError(
                 "Parameter `task_id` is required when calling `delete_task_v1`."
@@ -5986,6 +6025,7 @@ def delete_task_v1(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> DeleteResponse:
         """
+        (Deprecated) delete_task_v1
         Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
 
 
@@ -6243,6 +6283,7 @@ def enable_task_v1_with_http_info(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
+        (Deprecated) enable_task_v1
         Enables a task using the v1 endpoint, please use `enableTask` instead.
 
         Required API Key ACLs:
@@ -6256,6 +6297,8 @@ def enable_task_v1_with_http_info(
         :return: Returns the raw algoliasearch 'APIResponse' object.
         """
 
+        warn("PUT /1/tasks/{taskID}/enable is deprecated.", DeprecationWarning)
+
         if task_id is None:
             raise ValueError(
                 "Parameter `task_id` is required when calling `enable_task_v1`."
@@ -6280,6 +6323,7 @@ def enable_task_v1(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> TaskUpdateResponse:
         """
+        (Deprecated) enable_task_v1
         Enables a task using the v1 endpoint, please use `enableTask` instead.
 
         Required API Key ACLs:
@@ -6672,6 +6716,7 @@ def get_task_v1_with_http_info(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
+        (Deprecated) get_task_v1
         Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
 
         Required API Key ACLs:
@@ -6685,6 +6730,8 @@ def get_task_v1_with_http_info(
         :return: Returns the raw algoliasearch 'APIResponse' object.
         """
 
+        warn("GET /1/tasks/{taskID} is deprecated.", DeprecationWarning)
+
         if task_id is None:
             raise ValueError(
                 "Parameter `task_id` is required when calling `get_task_v1`."
@@ -6707,6 +6754,7 @@ def get_task_v1(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> TaskV1:
         """
+        (Deprecated) get_task_v1
         Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
 
         Required API Key ACLs:
@@ -7980,6 +8028,7 @@ def list_tasks_v1_with_http_info(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
+        (Deprecated) list_tasks_v1
         Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
 
         Required API Key ACLs:
@@ -8009,6 +8058,8 @@ def list_tasks_v1_with_http_info(
         :return: Returns the raw algoliasearch 'APIResponse' object.
         """
 
+        warn("GET /1/tasks is deprecated.", DeprecationWarning)
+
         _query_parameters: Dict[str, Any] = {}
 
         if items_per_page is not None:
@@ -8091,6 +8142,7 @@ def list_tasks_v1(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ListTasksResponseV1:
         """
+        (Deprecated) list_tasks_v1
         Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
 
         Required API Key ACLs:
@@ -8518,6 +8570,7 @@ def run_task_v1_with_http_info(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
+        (Deprecated) run_task_v1
         Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
 
         Required API Key ACLs:
@@ -8531,6 +8584,8 @@ def run_task_v1_with_http_info(
         :return: Returns the raw algoliasearch 'APIResponse' object.
         """
 
+        warn("POST /1/tasks/{taskID}/run is deprecated.", DeprecationWarning)
+
         if task_id is None:
             raise ValueError(
                 "Parameter `task_id` is required when calling `run_task_v1`."
@@ -8555,6 +8610,7 @@ def run_task_v1(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> RunResponse:
         """
+        (Deprecated) run_task_v1
         Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
 
         Required API Key ACLs:
@@ -8816,6 +8872,7 @@ def search_tasks_v1_with_http_info(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
+        (Deprecated) search_tasks_v1
         Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
 
         Required API Key ACLs:
@@ -8829,6 +8886,8 @@ def search_tasks_v1_with_http_info(
         :return: Returns the raw algoliasearch 'APIResponse' object.
         """
 
+        warn("POST /1/tasks/search is deprecated.", DeprecationWarning)
+
         if task_search is None:
             raise ValueError(
                 "Parameter `task_search` is required when calling `search_tasks_v1`."
@@ -8854,6 +8913,7 @@ def search_tasks_v1(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> List[TaskV1]:
         """
+        (Deprecated) search_tasks_v1
         Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
 
         Required API Key ACLs:
@@ -9447,6 +9507,7 @@ def update_task_v1_with_http_info(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
+        (Deprecated) update_task_v1
         Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
 
 
@@ -9458,6 +9519,8 @@ def update_task_v1_with_http_info(
         :return: Returns the raw algoliasearch 'APIResponse' object.
         """
 
+        warn("PATCH /1/tasks/{taskID} is deprecated.", DeprecationWarning)
+
         if task_id is None:
             raise ValueError(
                 "Parameter `task_id` is required when calling `update_task_v1`."
@@ -9491,6 +9554,7 @@ def update_task_v1(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> TaskUpdateResponse:
         """
+        (Deprecated) update_task_v1
         Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.