capo-workdocs 0.1.0__py3-none-any.whl

capo_workdocs/types/principal_role_type.py

@@ -0,0 +1,19 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#PrincipalRoleType``."""
+
+from typing import Literal, TypeAlias, cast
+
+PrincipalRoleType: TypeAlias = Literal[
+    "VIEWER",
+    "CONTRIBUTOR",
+    "OWNER",
+    "COOWNER",
+]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: PrincipalRoleType) -> str:
+    return value
+
+
+def deserialize_json(data: str) -> PrincipalRoleType:
+    return cast(PrincipalRoleType, data)

capo_workdocs/types/principal_type.py

@@ -0,0 +1,20 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#PrincipalType``."""
+
+from typing import Literal, TypeAlias, cast
+
+PrincipalType: TypeAlias = Literal[
+    "USER",
+    "GROUP",
+    "INVITE",
+    "ANONYMOUS",
+    "ORGANIZATION",
+]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: PrincipalType) -> str:
+    return value
+
+
+def deserialize_json(data: str) -> PrincipalType:
+    return cast(PrincipalType, data)

capo_workdocs/types/remove_all_resource_permissions_request.py

@@ -0,0 +1,29 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#RemoveAllResourcePermissionsRequest``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.authentication_header_type
+    import capo_workdocs.types.resource_id_type
+
+
+class RemoveAllResourcePermissionsRequest(TypedDict, closed=True):
+    authentication_token: NotRequired[
+        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
+    ]
+    """<p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>"""
+    resource_id: "capo_workdocs.types.resource_id_type.ResourceIdType"
+    """<p>The ID of the resource.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: RemoveAllResourcePermissionsRequest) -> dict:
+    out: dict = {}
+    return out
+
+
+def deserialize_json(data: dict) -> RemoveAllResourcePermissionsRequest:
+    out: RemoveAllResourcePermissionsRequest = {}  # type: ignore[typeddict-item]
+    return out

capo_workdocs/types/remove_resource_permission_request.py

@@ -0,0 +1,35 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#RemoveResourcePermissionRequest``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.authentication_header_type
+    import capo_workdocs.types.id_type
+    import capo_workdocs.types.principal_type
+    import capo_workdocs.types.resource_id_type
+
+
+class RemoveResourcePermissionRequest(TypedDict, closed=True):
+    authentication_token: NotRequired[
+        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
+    ]
+    """<p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>"""
+    resource_id: "capo_workdocs.types.resource_id_type.ResourceIdType"
+    """<p>The ID of the resource.</p>"""
+    principal_id: "capo_workdocs.types.id_type.IdType"
+    """<p>The principal ID of the resource.</p>"""
+    principal_type: NotRequired["capo_workdocs.types.principal_type.PrincipalType"]
+    """<p>The principal type of the resource.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: RemoveResourcePermissionRequest) -> dict:
+    out: dict = {}
+    return out
+
+
+def deserialize_json(data: dict) -> RemoveResourcePermissionRequest:
+    out: RemoveResourcePermissionRequest = {}  # type: ignore[typeddict-item]
+    return out

capo_workdocs/types/resource_collection_type.py

@@ -0,0 +1,14 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#ResourceCollectionType``."""
+
+from typing import Literal, TypeAlias, cast
+
+ResourceCollectionType: TypeAlias = Literal["SHARED_WITH_ME",]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: ResourceCollectionType) -> str:
+    return value
+
+
+def deserialize_json(data: str) -> ResourceCollectionType:
+    return cast(ResourceCollectionType, data)

capo_workdocs/types/resource_id_type.py

@@ -0,0 +1,5 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#ResourceIdType``."""
+
+from typing import TypeAlias
+
+ResourceIdType: TypeAlias = str

capo_workdocs/types/resource_metadata.py

@@ -0,0 +1,80 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#ResourceMetadata``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.document_version_id_type
+    import capo_workdocs.types.resource_id_type
+    import capo_workdocs.types.resource_name_type
+    import capo_workdocs.types.resource_type
+    import capo_workdocs.types.user_metadata
+
+
+class ResourceMetadata(TypedDict, closed=True):
+    type: NotRequired["capo_workdocs.types.resource_type.ResourceType"]
+    """<p>The type of resource.</p>"""
+    name: NotRequired["capo_workdocs.types.resource_name_type.ResourceNameType"]
+    """<p>The name of the resource.</p>"""
+    original_name: NotRequired[
+        "capo_workdocs.types.resource_name_type.ResourceNameType"
+    ]
+    """<p>The original name of the resource before a rename operation.</p>"""
+    id: NotRequired["capo_workdocs.types.resource_id_type.ResourceIdType"]
+    """<p>The ID of the resource.</p>"""
+    version_id: NotRequired[
+        "capo_workdocs.types.document_version_id_type.DocumentVersionIdType"
+    ]
+    """<p>The version ID of the resource. This is an optional field and is filled for action on document version.</p>"""
+    owner: NotRequired["capo_workdocs.types.user_metadata.UserMetadata"]
+    """<p>The owner of the resource.</p>"""
+    parent_id: NotRequired["capo_workdocs.types.resource_id_type.ResourceIdType"]
+    """<p>The parent ID of the resource before a rename operation.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: ResourceMetadata) -> dict:
+    out: dict = {}
+    if "type" in value:
+        import capo_workdocs.types.resource_type
+
+        out["Type"] = capo_workdocs.types.resource_type.serialize_json(value["type"])
+    if "name" in value:
+        out["Name"] = value["name"]
+    if "original_name" in value:
+        out["OriginalName"] = value["original_name"]
+    if "id" in value:
+        out["Id"] = value["id"]
+    if "version_id" in value:
+        out["VersionId"] = value["version_id"]
+    if "owner" in value:
+        import capo_workdocs.types.user_metadata
+
+        out["Owner"] = capo_workdocs.types.user_metadata.serialize_json(value["owner"])
+    if "parent_id" in value:
+        out["ParentId"] = value["parent_id"]
+    return out
+
+
+def deserialize_json(data: dict) -> ResourceMetadata:
+    out: ResourceMetadata = {}  # type: ignore[typeddict-item]
+    if data.get("Type") is not None:
+        import capo_workdocs.types.resource_type
+
+        out["type"] = capo_workdocs.types.resource_type.deserialize_json(data["Type"])
+    if data.get("Name") is not None:
+        out["name"] = data["Name"]
+    if data.get("OriginalName") is not None:
+        out["original_name"] = data["OriginalName"]
+    if data.get("Id") is not None:
+        out["id"] = data["Id"]
+    if data.get("VersionId") is not None:
+        out["version_id"] = data["VersionId"]
+    if data.get("Owner") is not None:
+        import capo_workdocs.types.user_metadata
+
+        out["owner"] = capo_workdocs.types.user_metadata.deserialize_json(data["Owner"])
+    if data.get("ParentId") is not None:
+        out["parent_id"] = data["ParentId"]
+    return out

capo_workdocs/types/resource_name_type.py

@@ -0,0 +1,5 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#ResourceNameType``."""
+
+from typing import TypeAlias
+
+ResourceNameType: TypeAlias = str

capo_workdocs/types/resource_path.py

@@ -0,0 +1,42 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#ResourcePath``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.resource_path_component_list
+
+
+class ResourcePath(TypedDict, closed=True):
+    components: NotRequired[
+        "capo_workdocs.types.resource_path_component_list.ResourcePathComponentList"
+    ]
+    """<p>The components of the resource path.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: ResourcePath) -> dict:
+    out: dict = {}
+    if "components" in value:
+        import capo_workdocs.types.resource_path_component_list
+
+        out["Components"] = (
+            capo_workdocs.types.resource_path_component_list.serialize_json(
+                value["components"]
+            )
+        )
+    return out
+
+
+def deserialize_json(data: dict) -> ResourcePath:
+    out: ResourcePath = {}  # type: ignore[typeddict-item]
+    if data.get("Components") is not None:
+        import capo_workdocs.types.resource_path_component_list
+
+        out["components"] = (
+            capo_workdocs.types.resource_path_component_list.deserialize_json(
+                data["Components"]
+            )
+        )
+    return out

capo_workdocs/types/resource_path_component.py

@@ -0,0 +1,35 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#ResourcePathComponent``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.id_type
+    import capo_workdocs.types.resource_name_type
+
+
+class ResourcePathComponent(TypedDict, closed=True):
+    id: NotRequired["capo_workdocs.types.id_type.IdType"]
+    """<p>The ID of the resource path.</p>"""
+    name: NotRequired["capo_workdocs.types.resource_name_type.ResourceNameType"]
+    """<p>The name of the resource path.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: ResourcePathComponent) -> dict:
+    out: dict = {}
+    if "id" in value:
+        out["Id"] = value["id"]
+    if "name" in value:
+        out["Name"] = value["name"]
+    return out
+
+
+def deserialize_json(data: dict) -> ResourcePathComponent:
+    out: ResourcePathComponent = {}  # type: ignore[typeddict-item]
+    if data.get("Id") is not None:
+        out["id"] = data["Id"]
+    if data.get("Name") is not None:
+        out["name"] = data["Name"]
+    return out

capo_workdocs/types/resource_path_component_list.py

@@ -0,0 +1,31 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#ResourcePathComponentList``."""
+
+from typing import TYPE_CHECKING, TypeAlias
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.resource_path_component
+
+ResourcePathComponentList: TypeAlias = list[
+    "capo_workdocs.types.resource_path_component.ResourcePathComponent"
+]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: ResourcePathComponentList) -> list:
+    import capo_workdocs.types.resource_path_component
+
+    out: list = []
+    for item in value:
+        out.append(capo_workdocs.types.resource_path_component.serialize_json(item))
+    return out
+
+
+def deserialize_json(data: list) -> ResourcePathComponentList:
+    import capo_workdocs.types.resource_path_component
+
+    out: ResourcePathComponentList = []
+    for item in data:
+        if item is None:
+            continue
+        out.append(capo_workdocs.types.resource_path_component.deserialize_json(item))
+    return out

capo_workdocs/types/resource_sort_type.py

@@ -0,0 +1,17 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#ResourceSortType``."""
+
+from typing import Literal, TypeAlias, cast
+
+ResourceSortType: TypeAlias = Literal[
+    "DATE",
+    "NAME",
+]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: ResourceSortType) -> str:
+    return value
+
+
+def deserialize_json(data: str) -> ResourceSortType:
+    return cast(ResourceSortType, data)

capo_workdocs/types/resource_state_type.py

@@ -0,0 +1,19 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#ResourceStateType``."""
+
+from typing import Literal, TypeAlias, cast
+
+ResourceStateType: TypeAlias = Literal[
+    "ACTIVE",
+    "RESTORING",
+    "RECYCLING",
+    "RECYCLED",
+]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: ResourceStateType) -> str:
+    return value
+
+
+def deserialize_json(data: str) -> ResourceStateType:
+    return cast(ResourceStateType, data)

capo_workdocs/types/resource_type.py

@@ -0,0 +1,17 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#ResourceType``."""
+
+from typing import Literal, TypeAlias, cast
+
+ResourceType: TypeAlias = Literal[
+    "FOLDER",
+    "DOCUMENT",
+]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: ResourceType) -> str:
+    return value
+
+
+def deserialize_json(data: str) -> ResourceType:
+    return cast(ResourceType, data)

capo_workdocs/types/response_item.py

@@ -0,0 +1,117 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#ResponseItem``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.comment_metadata
+    import capo_workdocs.types.document_metadata
+    import capo_workdocs.types.document_version_metadata
+    import capo_workdocs.types.folder_metadata
+    import capo_workdocs.types.response_item_type
+    import capo_workdocs.types.response_item_web_url
+
+
+class ResponseItem(TypedDict, closed=True):
+    resource_type: NotRequired[
+        "capo_workdocs.types.response_item_type.ResponseItemType"
+    ]
+    """<p>The type of item being returned.</p>"""
+    web_url: NotRequired["capo_workdocs.types.response_item_web_url.ResponseItemWebUrl"]
+    """<p>The webUrl of the item being returned.</p>"""
+    document_metadata: NotRequired[
+        "capo_workdocs.types.document_metadata.DocumentMetadata"
+    ]
+    """<p>The document that matches the query.</p>"""
+    folder_metadata: NotRequired["capo_workdocs.types.folder_metadata.FolderMetadata"]
+    """<p>The folder that matches the query.</p>"""
+    comment_metadata: NotRequired[
+        "capo_workdocs.types.comment_metadata.CommentMetadata"
+    ]
+    """<p>The comment that matches the query.</p>"""
+    document_version_metadata: NotRequired[
+        "capo_workdocs.types.document_version_metadata.DocumentVersionMetadata"
+    ]
+    """<p>The document version that matches the metadata.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: ResponseItem) -> dict:
+    out: dict = {}
+    if "resource_type" in value:
+        import capo_workdocs.types.response_item_type
+
+        out["ResourceType"] = capo_workdocs.types.response_item_type.serialize_json(
+            value["resource_type"]
+        )
+    if "web_url" in value:
+        out["WebUrl"] = value["web_url"]
+    if "document_metadata" in value:
+        import capo_workdocs.types.document_metadata
+
+        out["DocumentMetadata"] = capo_workdocs.types.document_metadata.serialize_json(
+            value["document_metadata"]
+        )
+    if "folder_metadata" in value:
+        import capo_workdocs.types.folder_metadata
+
+        out["FolderMetadata"] = capo_workdocs.types.folder_metadata.serialize_json(
+            value["folder_metadata"]
+        )
+    if "comment_metadata" in value:
+        import capo_workdocs.types.comment_metadata
+
+        out["CommentMetadata"] = capo_workdocs.types.comment_metadata.serialize_json(
+            value["comment_metadata"]
+        )
+    if "document_version_metadata" in value:
+        import capo_workdocs.types.document_version_metadata
+
+        out["DocumentVersionMetadata"] = (
+            capo_workdocs.types.document_version_metadata.serialize_json(
+                value["document_version_metadata"]
+            )
+        )
+    return out
+
+
+def deserialize_json(data: dict) -> ResponseItem:
+    out: ResponseItem = {}  # type: ignore[typeddict-item]
+    if data.get("ResourceType") is not None:
+        import capo_workdocs.types.response_item_type
+
+        out["resource_type"] = capo_workdocs.types.response_item_type.deserialize_json(
+            data["ResourceType"]
+        )
+    if data.get("WebUrl") is not None:
+        out["web_url"] = data["WebUrl"]
+    if data.get("DocumentMetadata") is not None:
+        import capo_workdocs.types.document_metadata
+
+        out["document_metadata"] = (
+            capo_workdocs.types.document_metadata.deserialize_json(
+                data["DocumentMetadata"]
+            )
+        )
+    if data.get("FolderMetadata") is not None:
+        import capo_workdocs.types.folder_metadata
+
+        out["folder_metadata"] = capo_workdocs.types.folder_metadata.deserialize_json(
+            data["FolderMetadata"]
+        )
+    if data.get("CommentMetadata") is not None:
+        import capo_workdocs.types.comment_metadata
+
+        out["comment_metadata"] = capo_workdocs.types.comment_metadata.deserialize_json(
+            data["CommentMetadata"]
+        )
+    if data.get("DocumentVersionMetadata") is not None:
+        import capo_workdocs.types.document_version_metadata
+
+        out["document_version_metadata"] = (
+            capo_workdocs.types.document_version_metadata.deserialize_json(
+                data["DocumentVersionMetadata"]
+            )
+        )
+    return out

capo_workdocs/types/response_item_type.py

@@ -0,0 +1,19 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#ResponseItemType``."""
+
+from typing import Literal, TypeAlias, cast
+
+ResponseItemType: TypeAlias = Literal[
+    "DOCUMENT",
+    "FOLDER",
+    "COMMENT",
+    "DOCUMENT_VERSION",
+]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: ResponseItemType) -> str:
+    return value
+
+
+def deserialize_json(data: str) -> ResponseItemType:
+    return cast(ResponseItemType, data)

capo_workdocs/types/response_item_web_url.py

@@ -0,0 +1,5 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#ResponseItemWebUrl``."""
+
+from typing import TypeAlias
+
+ResponseItemWebUrl: TypeAlias = str

capo_workdocs/types/response_items_list.py

@@ -0,0 +1,29 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#ResponseItemsList``."""
+
+from typing import TYPE_CHECKING, TypeAlias
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.response_item
+
+ResponseItemsList: TypeAlias = list["capo_workdocs.types.response_item.ResponseItem"]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: ResponseItemsList) -> list:
+    import capo_workdocs.types.response_item
+
+    out: list = []
+    for item in value:
+        out.append(capo_workdocs.types.response_item.serialize_json(item))
+    return out
+
+
+def deserialize_json(data: list) -> ResponseItemsList:
+    import capo_workdocs.types.response_item
+
+    out: ResponseItemsList = []
+    for item in data:
+        if item is None:
+            continue
+        out.append(capo_workdocs.types.response_item.deserialize_json(item))
+    return out

capo_workdocs/types/restore_document_versions_request.py

@@ -0,0 +1,29 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#RestoreDocumentVersionsRequest``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.authentication_header_type
+    import capo_workdocs.types.resource_id_type
+
+
+class RestoreDocumentVersionsRequest(TypedDict, closed=True):
+    authentication_token: NotRequired[
+        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
+    ]
+    """<p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>"""
+    document_id: "capo_workdocs.types.resource_id_type.ResourceIdType"
+    """<p>The ID of the document.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: RestoreDocumentVersionsRequest) -> dict:
+    out: dict = {}
+    return out
+
+
+def deserialize_json(data: dict) -> RestoreDocumentVersionsRequest:
+    out: RestoreDocumentVersionsRequest = {}  # type: ignore[typeddict-item]
+    return out

capo_workdocs/types/role_permission_type.py

@@ -0,0 +1,17 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#RolePermissionType``."""
+
+from typing import Literal, TypeAlias, cast
+
+RolePermissionType: TypeAlias = Literal[
+    "DIRECT",
+    "INHERITED",
+]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: RolePermissionType) -> str:
+    return value
+
+
+def deserialize_json(data: str) -> RolePermissionType:
+    return cast(RolePermissionType, data)

capo_workdocs/types/role_type.py

@@ -0,0 +1,19 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#RoleType``."""
+
+from typing import Literal, TypeAlias, cast
+
+RoleType: TypeAlias = Literal[
+    "VIEWER",
+    "CONTRIBUTOR",
+    "OWNER",
+    "COOWNER",
+]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: RoleType) -> str:
+    return value
+
+
+def deserialize_json(data: str) -> RoleType:
+    return cast(RoleType, data)

capo_workdocs/types/search_ancestor_id.py

@@ -0,0 +1,5 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#SearchAncestorId``."""
+
+from typing import TypeAlias
+
+SearchAncestorId: TypeAlias = str

capo_workdocs/types/search_ancestor_id_list.py

@@ -0,0 +1,19 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#SearchAncestorIdList``."""
+
+from typing import TYPE_CHECKING, TypeAlias
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.search_ancestor_id
+
+SearchAncestorIdList: TypeAlias = list[
+    "capo_workdocs.types.search_ancestor_id.SearchAncestorId"
+]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: SearchAncestorIdList) -> list:
+    return list(value)
+
+
+def deserialize_json(data: list) -> SearchAncestorIdList:
+    return [item for item in data if item is not None]