feat(specs): add put task endpoint to ingestion api (generated)

algolia/api-clients-automation#5281

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Clément Vannicatte <[email protected]>

Author: algolia-bot

algoliasearch/ingestion/client.py

@@ -90,6 +90,7 @@
     TaskCreate,
     TaskCreateResponse,
     TaskCreateV1,
+    TaskReplace,
     TaskSearch,
     TaskSortKeys,
     TaskUpdate,
@@ -3848,6 +3849,74 @@ async def push_task(
         )
         return resp.deserialize(WatchResponse, resp.raw_data)
 
+    async def replace_task_with_http_info(
+        self,
+        task_id: Annotated[
+            StrictStr, Field(description="Unique identifier of a task.")
+        ],
+        task_replace: Union[TaskReplace, dict[str, Any]],
+        request_options: Optional[Union[dict, RequestOptions]] = None,
+    ) -> ApiResponse[str]:
+        """
+        Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
+
+
+        :param task_id: Unique identifier of a task. (required)
+        :type task_id: str
+        :param task_replace: (required)
+        :type task_replace: TaskReplace
+        :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.
+        """
+
+        if task_id is None:
+            raise ValueError(
+                "Parameter `task_id` is required when calling `replace_task`."
+            )
+
+        if task_replace is None:
+            raise ValueError(
+                "Parameter `task_replace` is required when calling `replace_task`."
+            )
+
+        _data = {}
+        if task_replace is not None:
+            _data = task_replace
+
+        return await self._transporter.request(
+            verb=Verb.PUT,
+            path="/2/tasks/{taskID}".replace("{taskID}", quote(str(task_id), safe="")),
+            request_options=self._request_options.merge(
+                data=dumps(body_serializer(_data)),
+                user_request_options=request_options,
+            ),
+            use_read_transporter=False,
+        )
+
+    async def replace_task(
+        self,
+        task_id: Annotated[
+            StrictStr, Field(description="Unique identifier of a task.")
+        ],
+        task_replace: Union[TaskReplace, dict[str, Any]],
+        request_options: Optional[Union[dict, RequestOptions]] = None,
+    ) -> TaskUpdateResponse:
+        """
+        Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
+
+
+        :param task_id: Unique identifier of a task. (required)
+        :type task_id: str
+        :param task_replace: (required)
+        :type task_replace: TaskReplace
+        :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 'TaskUpdateResponse' result object.
+        """
+        resp = await self.replace_task_with_http_info(
+            task_id, task_replace, request_options
+        )
+        return resp.deserialize(TaskUpdateResponse, resp.raw_data)
+
     async def run_source_with_http_info(
         self,
         source_id: Annotated[
@@ -4884,7 +4953,7 @@ async def update_task_with_http_info(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
-        Updates a task by its ID.
+        Partially updates a task by its ID.
 
 
         :param task_id: Unique identifier of a task. (required)
@@ -4928,7 +4997,7 @@ async def update_task(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> TaskUpdateResponse:
         """
-        Updates a task by its ID.
+        Partially updates a task by its ID.
 
 
         :param task_id: Unique identifier of a task. (required)
@@ -8956,6 +9025,72 @@ def push_task(
         )
         return resp.deserialize(WatchResponse, resp.raw_data)
 
+    def replace_task_with_http_info(
+        self,
+        task_id: Annotated[
+            StrictStr, Field(description="Unique identifier of a task.")
+        ],
+        task_replace: Union[TaskReplace, dict[str, Any]],
+        request_options: Optional[Union[dict, RequestOptions]] = None,
+    ) -> ApiResponse[str]:
+        """
+        Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
+
+
+        :param task_id: Unique identifier of a task. (required)
+        :type task_id: str
+        :param task_replace: (required)
+        :type task_replace: TaskReplace
+        :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.
+        """
+
+        if task_id is None:
+            raise ValueError(
+                "Parameter `task_id` is required when calling `replace_task`."
+            )
+
+        if task_replace is None:
+            raise ValueError(
+                "Parameter `task_replace` is required when calling `replace_task`."
+            )
+
+        _data = {}
+        if task_replace is not None:
+            _data = task_replace
+
+        return self._transporter.request(
+            verb=Verb.PUT,
+            path="/2/tasks/{taskID}".replace("{taskID}", quote(str(task_id), safe="")),
+            request_options=self._request_options.merge(
+                data=dumps(body_serializer(_data)),
+                user_request_options=request_options,
+            ),
+            use_read_transporter=False,
+        )
+
+    def replace_task(
+        self,
+        task_id: Annotated[
+            StrictStr, Field(description="Unique identifier of a task.")
+        ],
+        task_replace: Union[TaskReplace, dict[str, Any]],
+        request_options: Optional[Union[dict, RequestOptions]] = None,
+    ) -> TaskUpdateResponse:
+        """
+        Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
+
+
+        :param task_id: Unique identifier of a task. (required)
+        :type task_id: str
+        :param task_replace: (required)
+        :type task_replace: TaskReplace
+        :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 'TaskUpdateResponse' result object.
+        """
+        resp = self.replace_task_with_http_info(task_id, task_replace, request_options)
+        return resp.deserialize(TaskUpdateResponse, resp.raw_data)
+
     def run_source_with_http_info(
         self,
         source_id: Annotated[
@@ -9990,7 +10125,7 @@ def update_task_with_http_info(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
-        Updates a task by its ID.
+        Partially updates a task by its ID.
 
 
         :param task_id: Unique identifier of a task. (required)
@@ -10034,7 +10169,7 @@ def update_task(
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> TaskUpdateResponse:
         """
-        Updates a task by its ID.
+        Partially updates a task by its ID.
 
 
         :param task_id: Unique identifier of a task. (required)

algoliasearch/ingestion/models/__init__.py

@@ -132,6 +132,7 @@
 from .task_create_trigger import TaskCreateTrigger
 from .task_create_v1 import TaskCreateV1
 from .task_input import TaskInput
+from .task_replace import TaskReplace
 from .task_search import TaskSearch
 from .task_sort_keys import TaskSortKeys
 from .task_update import TaskUpdate
@@ -282,6 +283,7 @@
     "TaskCreateTrigger",
     "TaskCreateV1",
     "TaskInput",
+    "TaskReplace",
     "TaskSearch",
     "TaskSortKeys",
     "TaskUpdate",

algoliasearch/ingestion/models/task_replace.py

@@ -0,0 +1,116 @@
+# coding: utf-8
+
+"""
+Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+"""
+
+from __future__ import annotations
+
+from json import loads
+from sys import version_info
+from typing import Any, Dict, Optional
+
+from pydantic import BaseModel, ConfigDict
+
+if version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing_extensions import Self
+
+
+from algoliasearch.ingestion.models.action_type import ActionType
+from algoliasearch.ingestion.models.notifications import Notifications
+from algoliasearch.ingestion.models.policies import Policies
+from algoliasearch.ingestion.models.task_input import TaskInput
+
+_ALIASES = {
+    "destination_id": "destinationID",
+    "action": "action",
+    "subscription_action": "subscriptionAction",
+    "cron": "cron",
+    "enabled": "enabled",
+    "failure_threshold": "failureThreshold",
+    "input": "input",
+    "cursor": "cursor",
+    "notifications": "notifications",
+    "policies": "policies",
+}
+
+
+def _alias_generator(name: str) -> str:
+    return _ALIASES.get(name, name)
+
+
+class TaskReplace(BaseModel):
+    """
+    API request body for updating a task.
+    """
+
+    destination_id: str
+    """ Universally unique identifier (UUID) of a destination resource. """
+    action: ActionType
+    subscription_action: Optional[ActionType] = None
+    cron: Optional[str] = None
+    """ Cron expression for the task's schedule. """
+    enabled: Optional[bool] = None
+    """ Whether the task is enabled. """
+    failure_threshold: Optional[int] = None
+    """ Maximum accepted percentage of failures for a task run to finish successfully. """
+    input: Optional[TaskInput] = None
+    cursor: Optional[str] = None
+    """ Date of the last cursor in RFC 3339 format. """
+    notifications: Optional[Notifications] = None
+    policies: Optional[Policies] = None
+
+    model_config = ConfigDict(
+        strict=False,
+        use_enum_values=True,
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+        alias_generator=_alias_generator,
+        extra="allow",
+    )
+
+    def to_json(self) -> str:
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of TaskReplace from a JSON string"""
+        return cls.from_dict(loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias."""
+        return self.model_dump(
+            by_alias=True,
+            exclude_none=True,
+            exclude_unset=True,
+        )
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TaskReplace from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        obj["action"] = obj.get("action")
+        obj["subscriptionAction"] = obj.get("subscriptionAction")
+        obj["input"] = (
+            TaskInput.from_dict(obj["input"]) if obj.get("input") is not None else None
+        )
+        obj["notifications"] = (
+            Notifications.from_dict(obj["notifications"])
+            if obj.get("notifications") is not None
+            else None
+        )
+        obj["policies"] = (
+            Policies.from_dict(obj["policies"])
+            if obj.get("policies") is not None
+            else None
+        )
+
+        return cls.model_validate(obj)

algoliasearch/ingestion/models/task_update.py

@@ -41,7 +41,7 @@ def _alias_generator(name: str) -> str:
 
 class TaskUpdate(BaseModel):
     """
-    API request body for updating a task.
+    API request body for partially updating a task.
     """
 
     destination_id: Optional[str] = None