Skip to content

FolderMetadata

Source code in docs_src/capo_workdocs/types/folder_metadata.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
class FolderMetadata(TypedDict, closed=True):
    id: NotRequired["capo_workdocs.types.resource_id_type.ResourceIdType"]
    """<p>The ID of the folder.</p>"""
    name: NotRequired["capo_workdocs.types.resource_name_type.ResourceNameType"]
    """<p>The name of the folder.</p>"""
    creator_id: NotRequired["capo_workdocs.types.id_type.IdType"]
    """<p>The ID of the creator.</p>"""
    parent_folder_id: NotRequired["capo_workdocs.types.resource_id_type.ResourceIdType"]
    """<p>The ID of the parent folder.</p>"""
    created_timestamp: NotRequired["capo_workdocs.types.timestamp_type.TimestampType"]
    """<p>The time when the folder was created.</p>"""
    modified_timestamp: NotRequired["capo_workdocs.types.timestamp_type.TimestampType"]
    """<p>The time when the folder was updated.</p>"""
    resource_state: NotRequired[
        "capo_workdocs.types.resource_state_type.ResourceStateType"
    ]
    """<p>The resource state of the folder.</p>"""
    signature: NotRequired["capo_workdocs.types.hash_type.HashType"]
    """<p>The unique identifier created from the subfolders and documents of the folder.</p>"""
    labels: NotRequired["capo_workdocs.types.shared_labels.SharedLabels"]
    """<p>List of labels on the folder.</p>"""
    size: NotRequired["capo_workdocs.types.size_type.SizeType"]
    """<p>The size of the folder metadata.</p>"""
    latest_version_size: NotRequired["capo_workdocs.types.size_type.SizeType"]
    """<p>The size of the latest version of the folder metadata.</p>"""

created_timestamp instance-attribute 

created_timestamp: NotRequired[TimestampType]

The time when the folder was created.

creator_id instance-attribute 

creator_id: NotRequired[IdType]

The ID of the creator.

id instance-attribute 

id: NotRequired[ResourceIdType]

The ID of the folder.

labels instance-attribute 

labels: NotRequired[SharedLabels]

List of labels on the folder.

latest_version_size instance-attribute 

latest_version_size: NotRequired[SizeType]

The size of the latest version of the folder metadata.

modified_timestamp instance-attribute 

modified_timestamp: NotRequired[TimestampType]

The time when the folder was updated.

name instance-attribute 

name: NotRequired[ResourceNameType]

The name of the folder.

parent_folder_id instance-attribute 

parent_folder_id: NotRequired[ResourceIdType]

The ID of the parent folder.

resource_state instance-attribute 

resource_state: NotRequired[ResourceStateType]

The resource state of the folder.

signature instance-attribute 

signature: NotRequired[HashType]

The unique identifier created from the subfolders and documents of the folder.

size instance-attribute 

size: NotRequired[SizeType]

The size of the folder metadata.