feat(specs): document runMetadata parameter (generated)

algolia/api-clients-automation#5087

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Devin Beeuwkes <[email protected]>

Author: algolia-bot

algoliasearch/ingestion/client.py

@@ -76,6 +76,7 @@
     RunSourcePayload,
     RunSourceResponse,
     RunStatus,
+    RunTaskPayload,
     RunType,
     Source,
     SourceCreate,
@@ -3916,6 +3917,7 @@ async def run_task_with_http_info(
         task_id: Annotated[
             StrictStr, Field(description="Unique identifier of a task.")
         ],
+        run_task_payload: Union[Optional[RunTaskPayload], dict[str, Any]] = None,
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
@@ -3928,19 +3930,26 @@ async def run_task_with_http_info(
 
         :param task_id: Unique identifier of a task. (required)
         :type task_id: str
+        :param run_task_payload:
+        :type run_task_payload: RunTaskPayload
         :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 `run_task`.")
 
+        _data = {}
+        if run_task_payload is not None:
+            _data = run_task_payload
+
         return await self._transporter.request(
             verb=Verb.POST,
             path="/2/tasks/{taskID}/run".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,
@@ -3951,6 +3960,7 @@ async def run_task(
         task_id: Annotated[
             StrictStr, Field(description="Unique identifier of a task.")
         ],
+        run_task_payload: Union[Optional[RunTaskPayload], dict[str, Any]] = None,
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> RunResponse:
         """
@@ -3963,17 +3973,22 @@ async def run_task(
 
         :param task_id: Unique identifier of a task. (required)
         :type task_id: str
+        :param run_task_payload:
+        :type run_task_payload: RunTaskPayload
         :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 'RunResponse' result object.
         """
-        resp = await self.run_task_with_http_info(task_id, request_options)
+        resp = await self.run_task_with_http_info(
+            task_id, run_task_payload, request_options
+        )
         return resp.deserialize(RunResponse, resp.raw_data)
 
     async def run_task_v1_with_http_info(
         self,
         task_id: Annotated[
             StrictStr, Field(description="Unique identifier of a task.")
         ],
+        run_task_payload: Union[Optional[RunTaskPayload], dict[str, Any]] = None,
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
@@ -3987,6 +4002,8 @@ async def run_task_v1_with_http_info(
 
         :param task_id: Unique identifier of a task. (required)
         :type task_id: str
+        :param run_task_payload:
+        :type run_task_payload: RunTaskPayload
         :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.
         """
@@ -3998,12 +4015,17 @@ async def run_task_v1_with_http_info(
                 "Parameter `task_id` is required when calling `run_task_v1`."
             )
 
+        _data = {}
+        if run_task_payload is not None:
+            _data = run_task_payload
+
         return await self._transporter.request(
             verb=Verb.POST,
             path="/1/tasks/{taskID}/run".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,
@@ -4014,6 +4036,7 @@ async def run_task_v1(
         task_id: Annotated[
             StrictStr, Field(description="Unique identifier of a task.")
         ],
+        run_task_payload: Union[Optional[RunTaskPayload], dict[str, Any]] = None,
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> RunResponse:
         """
@@ -4027,10 +4050,14 @@ async def run_task_v1(
 
         :param task_id: Unique identifier of a task. (required)
         :type task_id: str
+        :param run_task_payload:
+        :type run_task_payload: RunTaskPayload
         :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 'RunResponse' result object.
         """
-        resp = await self.run_task_v1_with_http_info(task_id, request_options)
+        resp = await self.run_task_v1_with_http_info(
+            task_id, run_task_payload, request_options
+        )
         return resp.deserialize(RunResponse, resp.raw_data)
 
     async def search_authentications_with_http_info(
@@ -8989,6 +9016,7 @@ def run_task_with_http_info(
         task_id: Annotated[
             StrictStr, Field(description="Unique identifier of a task.")
         ],
+        run_task_payload: Union[Optional[RunTaskPayload], dict[str, Any]] = None,
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
@@ -9001,19 +9029,26 @@ def run_task_with_http_info(
 
         :param task_id: Unique identifier of a task. (required)
         :type task_id: str
+        :param run_task_payload:
+        :type run_task_payload: RunTaskPayload
         :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 `run_task`.")
 
+        _data = {}
+        if run_task_payload is not None:
+            _data = run_task_payload
+
         return self._transporter.request(
             verb=Verb.POST,
             path="/2/tasks/{taskID}/run".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,
@@ -9024,6 +9059,7 @@ def run_task(
         task_id: Annotated[
             StrictStr, Field(description="Unique identifier of a task.")
         ],
+        run_task_payload: Union[Optional[RunTaskPayload], dict[str, Any]] = None,
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> RunResponse:
         """
@@ -9036,17 +9072,20 @@ def run_task(
 
         :param task_id: Unique identifier of a task. (required)
         :type task_id: str
+        :param run_task_payload:
+        :type run_task_payload: RunTaskPayload
         :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 'RunResponse' result object.
         """
-        resp = self.run_task_with_http_info(task_id, request_options)
+        resp = self.run_task_with_http_info(task_id, run_task_payload, request_options)
         return resp.deserialize(RunResponse, resp.raw_data)
 
     def run_task_v1_with_http_info(
         self,
         task_id: Annotated[
             StrictStr, Field(description="Unique identifier of a task.")
         ],
+        run_task_payload: Union[Optional[RunTaskPayload], dict[str, Any]] = None,
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> ApiResponse[str]:
         """
@@ -9060,6 +9099,8 @@ def run_task_v1_with_http_info(
 
         :param task_id: Unique identifier of a task. (required)
         :type task_id: str
+        :param run_task_payload:
+        :type run_task_payload: RunTaskPayload
         :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.
         """
@@ -9071,12 +9112,17 @@ def run_task_v1_with_http_info(
                 "Parameter `task_id` is required when calling `run_task_v1`."
             )
 
+        _data = {}
+        if run_task_payload is not None:
+            _data = run_task_payload
+
         return self._transporter.request(
             verb=Verb.POST,
             path="/1/tasks/{taskID}/run".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,
@@ -9087,6 +9133,7 @@ def run_task_v1(
         task_id: Annotated[
             StrictStr, Field(description="Unique identifier of a task.")
         ],
+        run_task_payload: Union[Optional[RunTaskPayload], dict[str, Any]] = None,
         request_options: Optional[Union[dict, RequestOptions]] = None,
     ) -> RunResponse:
         """
@@ -9100,10 +9147,14 @@ def run_task_v1(
 
         :param task_id: Unique identifier of a task. (required)
         :type task_id: str
+        :param run_task_payload:
+        :type run_task_payload: RunTaskPayload
         :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 'RunResponse' result object.
         """
-        resp = self.run_task_v1_with_http_info(task_id, request_options)
+        resp = self.run_task_v1_with_http_info(
+            task_id, run_task_payload, request_options
+        )
         return resp.deserialize(RunResponse, resp.raw_data)
 
     def search_authentications_with_http_info(

algoliasearch/ingestion/models/__init__.py

@@ -92,6 +92,7 @@
 from .run_source_payload import RunSourcePayload
 from .run_source_response import RunSourceResponse
 from .run_status import RunStatus
+from .run_task_payload import RunTaskPayload
 from .run_type import RunType
 from .schedule_trigger import ScheduleTrigger
 from .schedule_trigger_input import ScheduleTriggerInput
@@ -241,6 +242,7 @@
     "RunSourcePayload",
     "RunSourceResponse",
     "RunStatus",
+    "RunTaskPayload",
     "RunType",
     "ScheduleTrigger",
     "ScheduleTriggerInput",

algoliasearch/ingestion/models/run_source_payload.py

@@ -25,6 +25,7 @@
     "index_to_exclude": "indexToExclude",
     "entity_ids": "entityIDs",
     "entity_type": "entityType",
+    "run_metadata": "runMetadata",
 }
 
 
@@ -44,6 +45,8 @@ class RunSourcePayload(BaseModel):
     entity_ids: Optional[List[str]] = None
     """ List of entityIDs to update. """
     entity_type: Optional[EntityType] = None
+    run_metadata: Optional[Dict[str, object]] = None
+    """ Additional information that will be passed to the created runs. """
 
     model_config = ConfigDict(
         strict=False,

algoliasearch/ingestion/models/run_task_payload.py

@@ -0,0 +1,73 @@
+# 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
+
+
+_ALIASES = {
+    "run_metadata": "runMetadata",
+}
+
+
+def _alias_generator(name: str) -> str:
+    return _ALIASES.get(name, name)
+
+
+class RunTaskPayload(BaseModel):
+    """
+    RunTaskPayload
+    """
+
+    run_metadata: Optional[Dict[str, object]] = None
+    """ Additional information that will be passed to the created run. """
+
+    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 RunTaskPayload 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 RunTaskPayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        return cls.model_validate(obj)