flip_api.domain.interfaces.shared
=================================

.. py:module:: flip_api.domain.interfaces.shared


Attributes
----------

.. autoapisummary::

   flip_api.domain.interfaces.shared.Base
   flip_api.domain.interfaces.shared.ProcessEnv


Classes
-------

.. autoapisummary::

   flip_api.domain.interfaces.shared.IId
   flip_api.domain.interfaces.shared.IFileInfo
   flip_api.domain.interfaces.shared.IScannedFileRecord
   flip_api.domain.interfaces.shared.IScannedFileSns
   flip_api.domain.interfaces.shared.IScannedFileMessage
   flip_api.domain.interfaces.shared.IScannedFileInput
   flip_api.domain.interfaces.shared.SQLArray
   flip_api.domain.interfaces.shared.ICount
   flip_api.domain.interfaces.shared.IContext
   flip_api.domain.interfaces.shared.IAccessRequest


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

.. py:data:: Base

.. py:data:: ProcessEnv

.. py:class:: IId

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


   .. py:attribute:: id
      :type:  uuid.UUID


.. py:class:: IFileInfo

   .. py:attribute:: name
      :type:  str


   .. py:attribute:: status
      :type:  flip_api.domain.schemas.status.FileUploadStatus


   .. py:attribute:: size
      :type:  int


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


   .. py:attribute:: tag
      :type:  flip_api.domain.schemas.status.FileUploadTag | None


.. py:class:: IScannedFileRecord

   .. py:attribute:: Sns
      :type:  IScannedFileSns


.. py:class:: IScannedFileSns

   .. py:attribute:: Message
      :type:  str


.. py:class:: IScannedFileMessage

   .. py:attribute:: bucket
      :type:  str


   .. py:attribute:: key
      :type:  str


   .. py:attribute:: status
      :type:  flip_api.domain.schemas.status.BucketStatus


   .. py:attribute:: action
      :type:  flip_api.domain.schemas.status.BucketAction


.. py:class:: IScannedFileInput

   .. py:attribute:: Records
      :type:  list[IScannedFileRecord]


.. py:class:: SQLArray

   .. py:attribute:: array
      :type:  list[str]


.. py:class:: ICount

   .. py:attribute:: count
      :type:  int


.. py:class:: IContext

   .. py:attribute:: dbConnection
      :type:  Any


.. py:class:: IAccessRequest

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


   Model for new user access requests.


   .. py:attribute:: email
      :type:  pydantic.EmailStr


   .. py:attribute:: full_name
      :type:  str


   .. py:attribute:: reason_for_access
      :type:  str


   .. py:attribute:: model_config