Skip to content

Activity

Source code in docs_src/capo_workdocs/types/activity.py
class Activity(TypedDict, closed=True):
    type: NotRequired["capo_workdocs.types.activity_type.ActivityType"]
    """<p>The activity type.</p>"""
    time_stamp: NotRequired["capo_workdocs.types.timestamp_type.TimestampType"]
    """<p>The timestamp when the action was performed.</p>"""
    is_indirect_activity: "capo_workdocs.types.boolean_type.BooleanType"
    """<p>Indicates whether an activity is indirect or direct. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).</p>"""
    organization_id: NotRequired["capo_workdocs.types.id_type.IdType"]
    """<p>The ID of the organization.</p>"""
    initiator: NotRequired["capo_workdocs.types.user_metadata.UserMetadata"]
    """<p>The user who performed the action.</p>"""
    participants: NotRequired["capo_workdocs.types.participants.Participants"]
    """<p>The list of users or groups impacted by this action. This is an optional field and is filled for the following sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.</p>"""
    resource_metadata: NotRequired[
        "capo_workdocs.types.resource_metadata.ResourceMetadata"
    ]
    """<p>The metadata of the resource involved in the user action.</p>"""
    original_parent: NotRequired[
        "capo_workdocs.types.resource_metadata.ResourceMetadata"
    ]
    """<p>The original parent of the resource. This is an optional field and is filled for move activities.</p>"""
    comment_metadata: NotRequired[
        "capo_workdocs.types.comment_metadata.CommentMetadata"
    ]
    """<p>Metadata of the commenting activity. This is an optional field and is filled for commenting activities.</p>"""

comment_metadata instance-attribute

comment_metadata: NotRequired[CommentMetadata]

Metadata of the commenting activity. This is an optional field and is filled for commenting activities.

initiator instance-attribute

initiator: NotRequired[UserMetadata]

The user who performed the action.

is_indirect_activity instance-attribute

is_indirect_activity: BooleanType

Indicates whether an activity is indirect or direct. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).

organization_id instance-attribute

organization_id: NotRequired[IdType]

The ID of the organization.

original_parent instance-attribute

original_parent: NotRequired[ResourceMetadata]

The original parent of the resource. This is an optional field and is filled for move activities.

participants instance-attribute

participants: NotRequired[Participants]

The list of users or groups impacted by this action. This is an optional field and is filled for the following sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.

resource_metadata instance-attribute

resource_metadata: NotRequired[ResourceMetadata]

The metadata of the resource involved in the user action.

time_stamp instance-attribute

time_stamp: NotRequired[TimestampType]

The timestamp when the action was performed.

type instance-attribute

type: NotRequired[ActivityType]

The activity type.