:py:mod:`ivcap_client.types`
============================

.. py:module:: ivcap_client.types

.. autoapi-nested-parse::

   Contains some shared types for properties



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

Classes
~~~~~~~

.. autoapisummary::

   ivcap_client.types.Unset
   ivcap_client.types.File
   ivcap_client.types.Response




Attributes
~~~~~~~~~~

.. autoapisummary::

   ivcap_client.types.UNSET
   ivcap_client.types.FileJsonType


.. py:class:: Unset


   .. py:method:: __bool__() -> Literal[False]



.. py:data:: UNSET
   :type: Unset

   

.. py:data:: FileJsonType

   

.. py:class:: File


   Contains information for file uploads

   .. py:attribute:: payload
      :type: BinaryIO

      

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

      

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

      

   .. py:method:: to_tuple() -> FileJsonType

      Return a tuple representation that httpx will accept for multipart/form-data



.. py:class:: Response


   Bases: :py:obj:`Generic`\ [\ :py:obj:`T`\ ]

   A response from an endpoint

   .. py:attribute:: status_code
      :type: http.HTTPStatus

      

   .. py:attribute:: content
      :type: bytes

      

   .. py:attribute:: headers
      :type: MutableMapping[str, str]

      

   .. py:attribute:: parsed
      :type: Optional[T]