pydantic_response_models.responses
==================================

.. py:module:: pydantic_response_models.responses

.. autoapi-nested-parse::

   Common API response DTOs.



Attributes
----------

.. autoapisummary::

   pydantic_response_models.responses.T


Classes
-------

.. autoapisummary::

   pydantic_response_models.responses.SuccessResponse
   pydantic_response_models.responses.ErrorDetail
   pydantic_response_models.responses.ErrorResponse
   pydantic_response_models.responses.PaginatedResponse
   pydantic_response_models.responses.MessageResponse


Module Contents
---------------

.. py:data:: T

.. py:class:: SuccessResponse

   Bases: :py:obj:`pydantic.BaseModel`, :py:obj:`Generic`\ [\ :py:obj:`T`\ ]


   Generic success response wrapper.


   .. py:attribute:: success
      :type:  bool
      :value: True



   .. py:attribute:: data
      :type:  T


   .. py:attribute:: message
      :type:  Optional[str]
      :value: None



.. py:class:: ErrorDetail

   Bases: :py:obj:`pydantic.BaseModel`


   Error detail model.


   .. py:attribute:: field
      :type:  Optional[str]


   .. py:attribute:: message
      :type:  str


   .. py:attribute:: code
      :type:  Optional[str]


.. py:class:: ErrorResponse

   Bases: :py:obj:`pydantic.BaseModel`


   Standard error response.


   .. py:attribute:: success
      :type:  bool
      :value: False



   .. py:attribute:: error
      :type:  str


   .. py:attribute:: details
      :type:  Optional[List[ErrorDetail]]


   .. py:attribute:: code
      :type:  Optional[str]


.. py:class:: PaginatedResponse

   Bases: :py:obj:`pydantic.BaseModel`, :py:obj:`Generic`\ [\ :py:obj:`T`\ ]


   Paginated response wrapper.


   .. py:attribute:: items
      :type:  List[T]


   .. py:attribute:: total
      :type:  int


   .. py:attribute:: page
      :type:  int


   .. py:attribute:: page_size
      :type:  int


   .. py:attribute:: pages
      :type:  int


.. py:class:: MessageResponse

   Bases: :py:obj:`pydantic.BaseModel`


   Simple message response.


   .. py:attribute:: message
      :type:  str


   .. py:attribute:: success
      :type:  bool
      :value: True