fix(specs): ingestion push task payload [skip-bc] (generated)

algolia/api-clients-automation#3607

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

Author: 3 people

algoliasearch/ingestion/client.py

@@ -34,7 +34,6 @@
 from algoliasearch.ingestion.models.authentication_update_response import (
     AuthenticationUpdateResponse,
 )
-from algoliasearch.ingestion.models.batch_write_params import BatchWriteParams
 from algoliasearch.ingestion.models.delete_response import DeleteResponse
 from algoliasearch.ingestion.models.destination import Destination
 from algoliasearch.ingestion.models.destination_create import DestinationCreate
@@ -73,6 +72,7 @@
 )
 from algoliasearch.ingestion.models.order_keys import OrderKeys
 from algoliasearch.ingestion.models.platform_with_none import PlatformWithNone
+from algoliasearch.ingestion.models.push_task_payload import PushTaskPayload
 from algoliasearch.ingestion.models.run import Run
 from algoliasearch.ingestion.models.run_list_response import RunListResponse
 from algoliasearch.ingestion.models.run_response import RunResponse
@@ -3385,8 +3385,8 @@ async def push_task_with_http_info(
         task_id: Annotated[
             StrictStr, Field(description="Unique identifier of a task.")
         ],
-        batch_write_params: Annotated[
-            BatchWriteParams,
+        push_task_payload: Annotated[
+            PushTaskPayload,
             Field(
                 description="Request body of a Search API `batch` request that will be pushed in the Connectors pipeline."
             ),
@@ -3403,8 +3403,8 @@ async def push_task_with_http_info(
 
         :param task_id: Unique identifier of a task. (required)
         :type task_id: str
-        :param batch_write_params: Request body of a Search API `batch` request that will be pushed in the Connectors pipeline. (required)
-        :type batch_write_params: BatchWriteParams
+        :param push_task_payload: Request body of a Search API `batch` request that will be pushed in the Connectors pipeline. (required)
+        :type push_task_payload: PushTaskPayload
         :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.
         """
@@ -3414,14 +3414,14 @@ async def push_task_with_http_info(
                 "Parameter `task_id` is required when calling `push_task`."
             )
 
-        if batch_write_params is None:
+        if push_task_payload is None:
             raise ValueError(
-                "Parameter `batch_write_params` is required when calling `push_task`."
+                "Parameter `push_task_payload` is required when calling `push_task`."
             )
 
         _data = {}
-        if batch_write_params is not None:
-            _data = batch_write_params
+        if push_task_payload is not None:
+            _data = push_task_payload
 
         return await self._transporter.request(
             verb=Verb.POST,
@@ -3440,8 +3440,8 @@ async def push_task(
         task_id: Annotated[
             StrictStr, Field(description="Unique identifier of a task.")
         ],
-        batch_write_params: Annotated[
-            BatchWriteParams,
+        push_task_payload: Annotated[
+            PushTaskPayload,
             Field(
                 description="Request body of a Search API `batch` request that will be pushed in the Connectors pipeline."
             ),
@@ -3458,14 +3458,14 @@ async def push_task(
 
         :param task_id: Unique identifier of a task. (required)
         :type task_id: str
-        :param batch_write_params: Request body of a Search API `batch` request that will be pushed in the Connectors pipeline. (required)
-        :type batch_write_params: BatchWriteParams
+        :param push_task_payload: Request body of a Search API `batch` request that will be pushed in the Connectors pipeline. (required)
+        :type push_task_payload: PushTaskPayload
         :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.
         """
         return (
             await self.push_task_with_http_info(
-                task_id, batch_write_params, request_options
+                task_id, push_task_payload, request_options
             )
         ).deserialize(RunResponse)
 

algoliasearch/ingestion/models/batch_write_params.py renamed to algoliasearch/ingestion/models/push_task_payload.py

@@ -11,15 +11,17 @@
 
 from pydantic import BaseModel, ConfigDict
 
-from algoliasearch.ingestion.models.batch_request import BatchRequest
+from algoliasearch.ingestion.models.action import Action
+from algoliasearch.ingestion.models.push_task_records import PushTaskRecords
 
 
-class BatchWriteParams(BaseModel):
+class PushTaskPayload(BaseModel):
     """
-    Batch parameters.
+    PushTaskPayload
     """
 
-    requests: List[BatchRequest]
+    action: Action
+    records: List[PushTaskRecords]
 
     model_config = ConfigDict(
         use_enum_values=True, populate_by_name=True, validate_assignment=True
@@ -30,7 +32,7 @@ def to_json(self) -> str:
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:
-        """Create an instance of BatchWriteParams from a JSON string"""
+        """Create an instance of PushTaskPayload from a JSON string"""
         return cls.from_dict(loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -49,16 +51,16 @@ def to_dict(self) -> Dict[str, Any]:
             exclude_none=True,
         )
         _items = []
-        if self.requests:
-            for _item in self.requests:
+        if self.records:
+            for _item in self.records:
                 if _item:
                     _items.append(_item.to_dict())
-            _dict["requests"] = _items
+            _dict["records"] = _items
         return _dict
 
     @classmethod
     def from_dict(cls, obj: Dict) -> Self:
-        """Create an instance of BatchWriteParams from a dict"""
+        """Create an instance of PushTaskPayload from a dict"""
         if obj is None:
             return None
 
@@ -67,11 +69,12 @@ def from_dict(cls, obj: Dict) -> Self:
 
         _obj = cls.model_validate(
             {
-                "requests": (
-                    [BatchRequest.from_dict(_item) for _item in obj.get("requests")]
-                    if obj.get("requests") is not None
+                "action": obj.get("action"),
+                "records": (
+                    [PushTaskRecords.from_dict(_item) for _item in obj.get("records")]
+                    if obj.get("records") is not None
                     else None
-                )
+                ),
             }
         )
         return _obj

algoliasearch/ingestion/models/batch_request.py renamed to algoliasearch/ingestion/models/push_task_records.py

@@ -7,22 +7,21 @@
 from __future__ import annotations
 
 from json import loads
-from typing import Any, Dict, Self
+from typing import Any, ClassVar, Dict, List, Self
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
 
-from algoliasearch.ingestion.models.action import Action
 
-
-class BatchRequest(BaseModel):
+class PushTaskRecords(BaseModel):
     """
-    BatchRequest
+    PushTaskRecords
     """
 
-    action: Action
-    body: Dict[str, Any] = Field(
-        description="Operation arguments (varies with specified `action`)."
+    object_id: StrictStr = Field(
+        description="Unique record identifier.", alias="objectID"
     )
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["objectID"]
 
     model_config = ConfigDict(
         use_enum_values=True, populate_by_name=True, validate_assignment=True
@@ -33,7 +32,7 @@ def to_json(self) -> str:
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:
-        """Create an instance of BatchRequest from a JSON string"""
+        """Create an instance of PushTaskRecords from a JSON string"""
         return cls.from_dict(loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -45,24 +44,35 @@ def to_dict(self) -> Dict[str, Any]:
         * `None` is only added to the output dict for nullable fields that
           were set at model initialization. Other fields with value `None`
           are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
         """
         _dict = self.model_dump(
             by_alias=True,
-            exclude={},
+            exclude={
+                "additional_properties",
+            },
             exclude_none=True,
         )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
         return _dict
 
     @classmethod
     def from_dict(cls, obj: Dict) -> Self:
-        """Create an instance of BatchRequest from a dict"""
+        """Create an instance of PushTaskRecords from a dict"""
         if obj is None:
             return None
 
         if not isinstance(obj, dict):
             return cls.model_validate(obj)
 
-        _obj = cls.model_validate(
-            {"action": obj.get("action"), "body": obj.get("body")}
-        )
+        _obj = cls.model_validate({"objectID": obj.get("objectID")})
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
         return _obj