Source code for openapi_client.models.list_agents_response

# coding: utf-8

"""
    Amorphic Data Platform

    Amorphic Data Platform - API Definition documentation

    The version of the OpenAPI document: 0.3.0
    Generated by OpenAPI Generator (https://openapi-generator.tech)

    Do not edit the class manually.
"""  # noqa: E501


from __future__ import annotations
import pprint
import re  # noqa: F401
import json

from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
from typing import Any, ClassVar, Dict, List, Optional
from openapi_client.models.get_agent_details_response import GetAgentDetailsResponse
from typing import Optional, Set
from typing_extensions import Self



class ListAgentsResponse(BaseModel):
    """
    Response for GET /ai/agents endpoint. Structure varies based on query parameters. See endpoint description for details.
    """ # noqa: E501
    agents: Optional[List[GetAgentDetailsResponse]] = Field(default=None, description="List of agents (present when no action parameter)")
    count: Optional[StrictInt] = Field(default=None, description="Number of agents in current page (present when no action parameter)")
    total_count: Optional[StrictInt] = Field(default=None, description="Total number of agents available (present when no action parameter)")
    next_available: Optional[StrictStr] = Field(default=None, description="Whether more pages are available (present when no action parameter)")
    additional_properties: Dict[str, Any] = {}
    __properties: ClassVar[List[str]] = ["agents", "count", "total_count", "next_available"]

    model_config = ConfigDict(
        populate_by_name=True,
        validate_assignment=True,
        protected_namespaces=(),
    )




    def to_str(self) -> str:
        """Returns the string representation of the model using alias"""
        return pprint.pformat(self.model_dump(by_alias=True))




    def to_json(self) -> str:
        """Returns the JSON representation of the model using alias"""
        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
        return json.dumps(self.to_dict())




    @classmethod
    def from_json(cls, json_str: str) -> Optional[Self]:
        """Create an instance of ListAgentsResponse from a JSON string"""
        return cls.from_dict(json.loads(json_str))




    def to_dict(self) -> Dict[str, Any]:
        """Return the dictionary representation of the model using alias.

        This has the following differences from calling pydantic's
        `self.model_dump(by_alias=True)`:

        * `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.
        """
        excluded_fields: Set[str] = set([
            "additional_properties",
        ])

        _dict = self.model_dump(
            by_alias=True,
            exclude=excluded_fields,
            exclude_none=True,
        )
        # override the default output from pydantic by calling `to_dict()` of each item in agents (list)
        _items = []
        if self.agents:
            for _item_agents in self.agents:
                if _item_agents:
                    _items.append(_item_agents.to_dict())
            _dict['agents'] = _items
        # 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: Optional[Dict[str, Any]]) -> Optional[Self]:
        """Create an instance of ListAgentsResponse from a dict"""
        if obj is None:
            return None

        if not isinstance(obj, dict):
            return cls.model_validate(obj)

        _obj = cls.model_validate({
            "agents": [GetAgentDetailsResponse.from_dict(_item) for _item in obj["agents"]] if obj.get("agents") is not None else None,
            "count": obj.get("count"),
            "total_count": obj.get("total_count"),
            "next_available": obj.get("next_available")
        })
        # 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