Sharing

Bases: BaseModel

Project-access information for current user.

Fields:

• is_owner (bool)
• permissions (str)
• owner_email (str)

57
58
59
60
61
62
63
64
65
66
67
68
69

class ProjectAccessRead(BaseModel):
    """
    Project-access information for current user.

    Attributes:
        is_owner: Whether current user is owner.
        permissions: Current user permissions.
        owner_email: Email of project owner
    """

    is_owner: bool
    permissions: str
    owner_email: str

Bases: BaseModel

Request body for project-sharing invitation.

Fields:

• permissions (ProjectPermissions)

20
21
22
23
24
25
26
27
28

class ProjectGuestCreate(BaseModel):
    """
    Request body for project-sharing invitation.

    Attributes:
        permissions:
    """

    permissions: ProjectPermissions

Bases: BaseModel

Information about a guest.

Fields:

• email (str)
• is_verified (bool)
• permissions (str)

31
32
33
34
35
36
37
38
39
40
41
42
43

class ProjectGuestRead(BaseModel):
    """
    Information about a guest.

    Attributes:
        email: Guest email.
        is_verified: Project/guest verification status.
        permissions: Guest permissions for project.
    """

    email: str
    is_verified: bool
    permissions: str

Bases: BaseModel

Request body for updating permissions of an existing guest.

Fields:

• permissions (ProjectPermissions)

46
47
48
49
50
51
52
53
54

class ProjectGuestUpdate(BaseModel):
    """
    Request body for updating permissions of an existing guest.

    Attributes:
        permissions: New permissions for guest.
    """

    permissions: ProjectPermissions

Bases: BaseModel

Info about a pending invitation.

Fields:

• project_id (int)
• project_name (str)
• owner_email (str)
• guest_permissions (str)

72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

class ProjectInvitationRead(BaseModel):
    """
    Info about a pending invitation.

    Attributes:
        project_id:
        project_name:
        owner_email:
        guest_permissions:
    """

    project_id: int
    project_name: str
    owner_email: str
    guest_permissions: str

Bases: StrEnum

Available permissions for accessing Project Attributes: READ: WRITE: EXECUTE:

 6
 7
 8
 9
10
11
12
13
14
15
16
17

class ProjectPermissions(StrEnum):
    """
    Available permissions for accessing Project
    Attributes:
        READ:
        WRITE:
        EXECUTE:
    """

    READ = "r"
    WRITE = "rw"
    EXECUTE = "rwx"