flip_api.domain.schemas.projects
================================

.. py:module:: flip_api.domain.schemas.projects


Attributes
----------

.. autoapisummary::

   flip_api.domain.schemas.projects.T


Classes
-------

.. autoapisummary::

   flip_api.domain.schemas.projects.UserAccessInfo
   flip_api.domain.schemas.projects.ProjectQueryInfo
   flip_api.domain.schemas.projects.ApprovedTrustInfo
   flip_api.domain.schemas.projects.ProjectDetailResponse
   flip_api.domain.schemas.projects.ProjectListItemSchema
   flip_api.domain.schemas.projects.PagedResponse
   flip_api.domain.schemas.projects.ImagingProject
   flip_api.domain.schemas.projects.XnatProjectStatusInfo
   flip_api.domain.schemas.projects.ApproveProjectBodyPayload
   flip_api.domain.schemas.projects.ProjectDetails
   flip_api.domain.schemas.projects.StageProjectRequest


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

.. py:class:: UserAccessInfo

   Bases: :py:obj:`sqlmodel.SQLModel`


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


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


.. py:class:: ProjectQueryInfo

   Bases: :py:obj:`sqlmodel.SQLModel`


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


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


.. py:class:: ApprovedTrustInfo

   Bases: :py:obj:`sqlmodel.SQLModel`


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


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


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


.. py:class:: ProjectDetailResponse

   Bases: :py:obj:`sqlmodel.SQLModel`


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


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


   .. py:attribute:: description
      :type:  str | None
      :value: None



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


   .. py:attribute:: owner_id
      :type:  uuid.UUID


   .. py:attribute:: created_at
      :type:  datetime.datetime


   .. py:attribute:: updated_at
      :type:  datetime.datetime


   .. py:attribute:: query_id
      :type:  uuid.UUID | None
      :value: None



   .. py:attribute:: owner_email
      :type:  str | None
      :value: None



   .. py:attribute:: query_details
      :type:  ProjectQueryInfo | None
      :value: None



   .. py:attribute:: approved_trusts
      :type:  list[ApprovedTrustInfo]
      :value: []



   .. py:attribute:: users_with_access
      :type:  list[UserAccessInfo]
      :value: []



.. py:class:: ProjectListItemSchema

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


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


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


   .. py:attribute:: description
      :type:  str | None
      :value: None



   .. py:attribute:: owner_id
      :type:  uuid.UUID


   .. py:attribute:: created_at
      :type:  datetime.datetime


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


   .. py:attribute:: model_config


.. py:data:: T

.. py:class:: PagedResponse

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


   Abstract base class for generic types.

   A generic type is typically declared by inheriting from
   this class parameterized with one or more type variables.
   For example, a generic mapping type might be defined as::

     class Mapping(Generic[KT, VT]):
         def __getitem__(self, key: KT) -> VT:
             ...
         # Etc.

   This class can then be used as follows::

     def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
         try:
             return mapping[key]
         except KeyError:
             return default


   .. py:attribute:: page_number
      :type:  int


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


   .. py:attribute:: total_pages
      :type:  int


   .. py:attribute:: total_records
      :type:  int


   .. py:attribute:: data
      :type:  list[T]


   .. py:attribute:: model_config


.. py:class:: ImagingProject

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


   .. py:attribute:: id
      :type:  uuid.UUID | None
      :value: None



   .. py:attribute:: xnat_project_id
      :type:  uuid.UUID | None
      :value: None



   .. py:attribute:: trust_id
      :type:  uuid.UUID


   .. py:attribute:: retrieve_image_status
      :type:  flip_api.domain.schemas.status.XNATImageStatus | None
      :value: None



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


   .. py:attribute:: reimport_count
      :type:  int
      :value: 0



.. py:class:: XnatProjectStatusInfo

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


   .. py:attribute:: retrieve_image_status
      :type:  flip_api.domain.schemas.status.XNATImageStatus


   .. py:attribute:: reimport_count
      :type:  int


.. py:class:: ApproveProjectBodyPayload

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


   .. py:attribute:: trusts
      :type:  list[uuid.UUID]


.. py:class:: ProjectDetails

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


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


   .. py:attribute:: description
      :type:  str | None


   .. py:attribute:: users
      :type:  list[uuid.UUID]


   .. py:attribute:: dicom_to_nifti
      :type:  bool


   .. py:method:: strip_whitespace(value: str)
      :classmethod:



   .. py:attribute:: model_config


.. py:class:: StageProjectRequest

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


   .. py:attribute:: trusts
      :type:  flip_api.domain.schemas.types.NonEmptyUUIDList


   .. py:attribute:: model_config