Skip to content

ShareResult

Source code in docs_src/capo_workdocs/types/share_result.py
class ShareResult(TypedDict, closed=True):
    principal_id: NotRequired["capo_workdocs.types.id_type.IdType"]
    """<p>The ID of the principal.</p>"""
    invitee_principal_id: NotRequired["capo_workdocs.types.id_type.IdType"]
    """<p>The ID of the invited user.</p>"""
    role: NotRequired["capo_workdocs.types.role_type.RoleType"]
    """<p>The role.</p>"""
    status: NotRequired["capo_workdocs.types.share_status_type.ShareStatusType"]
    """<p>The status.</p>"""
    share_id: NotRequired["capo_workdocs.types.resource_id_type.ResourceIdType"]
    """<p>The ID of the resource that was shared.</p>"""
    status_message: NotRequired["capo_workdocs.types.message_type.MessageType"]
    """<p>The status message.</p>"""

invitee_principal_id instance-attribute

invitee_principal_id: NotRequired[IdType]

The ID of the invited user.

principal_id instance-attribute

principal_id: NotRequired[IdType]

The ID of the principal.

role instance-attribute

role: NotRequired[RoleType]

The role.

share_id instance-attribute

share_id: NotRequired[ResourceIdType]

The ID of the resource that was shared.

status instance-attribute

status: NotRequired[ShareStatusType]

The status.

status_message instance-attribute

status_message: NotRequired[MessageType]

The status message.