capo-workdocs 0.1.0__py3-none-any.whl

capo_workdocs/types/describe_resource_permissions_response.py

@@ -0,0 +1,43 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#DescribeResourcePermissionsResponse``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.page_marker_type
+    import capo_workdocs.types.principal_list
+
+
+class DescribeResourcePermissionsResponse(TypedDict, closed=True):
+    principals: NotRequired["capo_workdocs.types.principal_list.PrincipalList"]
+    """<p>The principals.</p>"""
+    marker: NotRequired["capo_workdocs.types.page_marker_type.PageMarkerType"]
+    """<p>The marker to use when requesting the next set of results. If there are no additional results, the string is empty.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: DescribeResourcePermissionsResponse) -> dict:
+    out: dict = {}
+    if "principals" in value:
+        import capo_workdocs.types.principal_list
+
+        out["Principals"] = capo_workdocs.types.principal_list.serialize_json(
+            value["principals"]
+        )
+    if "marker" in value:
+        out["Marker"] = value["marker"]
+    return out
+
+
+def deserialize_json(data: dict) -> DescribeResourcePermissionsResponse:
+    out: DescribeResourcePermissionsResponse = {}  # type: ignore[typeddict-item]
+    if data.get("Principals") is not None:
+        import capo_workdocs.types.principal_list
+
+        out["principals"] = capo_workdocs.types.principal_list.deserialize_json(
+            data["Principals"]
+        )
+    if data.get("Marker") is not None:
+        out["marker"] = data["Marker"]
+    return out

capo_workdocs/types/describe_root_folders_request.py

@@ -0,0 +1,32 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#DescribeRootFoldersRequest``."""
+
+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.limit_type
+    import capo_workdocs.types.page_marker_type
+
+
+class DescribeRootFoldersRequest(TypedDict, closed=True):
+    authentication_token: (
+        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
+    )
+    """<p>Amazon WorkDocs authentication token.</p>"""
+    limit: NotRequired["capo_workdocs.types.limit_type.LimitType"]
+    """<p>The maximum number of items to return.</p>"""
+    marker: NotRequired["capo_workdocs.types.page_marker_type.PageMarkerType"]
+    """<p>The marker for the next set of results. (You received this marker from a previous call.)</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: DescribeRootFoldersRequest) -> dict:
+    out: dict = {}
+    return out
+
+
+def deserialize_json(data: dict) -> DescribeRootFoldersRequest:
+    out: DescribeRootFoldersRequest = {}  # type: ignore[typeddict-item]
+    return out

capo_workdocs/types/describe_root_folders_response.py

@@ -0,0 +1,43 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#DescribeRootFoldersResponse``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.folder_metadata_list
+    import capo_workdocs.types.page_marker_type
+
+
+class DescribeRootFoldersResponse(TypedDict, closed=True):
+    folders: NotRequired["capo_workdocs.types.folder_metadata_list.FolderMetadataList"]
+    """<p>The user's special folders.</p>"""
+    marker: NotRequired["capo_workdocs.types.page_marker_type.PageMarkerType"]
+    """<p>The marker for the next set of results.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: DescribeRootFoldersResponse) -> dict:
+    out: dict = {}
+    if "folders" in value:
+        import capo_workdocs.types.folder_metadata_list
+
+        out["Folders"] = capo_workdocs.types.folder_metadata_list.serialize_json(
+            value["folders"]
+        )
+    if "marker" in value:
+        out["Marker"] = value["marker"]
+    return out
+
+
+def deserialize_json(data: dict) -> DescribeRootFoldersResponse:
+    out: DescribeRootFoldersResponse = {}  # type: ignore[typeddict-item]
+    if data.get("Folders") is not None:
+        import capo_workdocs.types.folder_metadata_list
+
+        out["folders"] = capo_workdocs.types.folder_metadata_list.deserialize_json(
+            data["Folders"]
+        )
+    if data.get("Marker") is not None:
+        out["marker"] = data["Marker"]
+    return out

capo_workdocs/types/describe_users_request.py

@@ -0,0 +1,53 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#DescribeUsersRequest``."""
+
+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.field_names_type
+    import capo_workdocs.types.id_type
+    import capo_workdocs.types.limit_type
+    import capo_workdocs.types.order_type
+    import capo_workdocs.types.page_marker_type
+    import capo_workdocs.types.search_query_type
+    import capo_workdocs.types.user_filter_type
+    import capo_workdocs.types.user_ids_type
+    import capo_workdocs.types.user_sort_type
+
+
+class DescribeUsersRequest(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>"""
+    organization_id: NotRequired["capo_workdocs.types.id_type.IdType"]
+    """<p>The ID of the organization.</p>"""
+    user_ids: NotRequired["capo_workdocs.types.user_ids_type.UserIdsType"]
+    """<p>The IDs of the users.</p>"""
+    query: NotRequired["capo_workdocs.types.search_query_type.SearchQueryType"]
+    r"""<p>A query to filter users by user name. Remember the following about the <code>Userids</code> and <code>Query</code> parameters:</p> <ul> <li> <p>If you don't use either parameter, the API returns a paginated list of all users on the site.</p> </li> <li> <p>If you use both parameters, the API ignores the <code>Query</code> parameter.</p> </li> <li> <p>The <code>Userid</code> parameter only returns user names that match a corresponding user ID.</p> </li> <li> <p>The <code>Query</code> parameter runs a \"prefix\" search for users by the <code>GivenName</code>, <code>SurName</code>, or <code>UserName</code> fields included in a <a href=\"https://docs.aws.amazon.com/workdocs/latest/APIReference/API_CreateUser.html\">CreateUser</a> API call. For example, querying on <code>Ma</code> returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on <code>Ma J</code> only returns Mateo Jackson.</p> </li> </ul>"""
+    include: NotRequired["capo_workdocs.types.user_filter_type.UserFilterType"]
+    r"""<p>The state of the users. Specify \"ALL\" to include inactive users.</p>"""
+    order: NotRequired["capo_workdocs.types.order_type.OrderType"]
+    """<p>The order for the results.</p>"""
+    sort: NotRequired["capo_workdocs.types.user_sort_type.UserSortType"]
+    """<p>The sorting criteria.</p>"""
+    marker: NotRequired["capo_workdocs.types.page_marker_type.PageMarkerType"]
+    """<p>The marker for the next set of results. (You received this marker from a previous call.)</p>"""
+    limit: NotRequired["capo_workdocs.types.limit_type.LimitType"]
+    """<p>The maximum number of items to return.</p>"""
+    fields: NotRequired["capo_workdocs.types.field_names_type.FieldNamesType"]
+    r"""<p>A comma-separated list of values. Specify \"STORAGE_METADATA\" to include the user storage quota and utilization information.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: DescribeUsersRequest) -> dict:
+    out: dict = {}
+    return out
+
+
+def deserialize_json(data: dict) -> DescribeUsersRequest:
+    out: DescribeUsersRequest = {}  # type: ignore[typeddict-item]
+    return out

capo_workdocs/types/describe_users_response.py

@@ -0,0 +1,52 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#DescribeUsersResponse``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.organization_user_list
+    import capo_workdocs.types.page_marker_type
+    import capo_workdocs.types.size_type
+
+
+class DescribeUsersResponse(TypedDict, closed=True):
+    users: NotRequired[
+        "capo_workdocs.types.organization_user_list.OrganizationUserList"
+    ]
+    """<p>The users.</p>"""
+    total_number_of_users: NotRequired["capo_workdocs.types.size_type.SizeType"]
+    """<p>The total number of users included in the results.</p>"""
+    marker: NotRequired["capo_workdocs.types.page_marker_type.PageMarkerType"]
+    """<p>The marker to use when requesting the next set of results. If there are no additional results, the string is empty.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: DescribeUsersResponse) -> dict:
+    out: dict = {}
+    if "users" in value:
+        import capo_workdocs.types.organization_user_list
+
+        out["Users"] = capo_workdocs.types.organization_user_list.serialize_json(
+            value["users"]
+        )
+    if "total_number_of_users" in value:
+        out["TotalNumberOfUsers"] = value["total_number_of_users"]
+    if "marker" in value:
+        out["Marker"] = value["marker"]
+    return out
+
+
+def deserialize_json(data: dict) -> DescribeUsersResponse:
+    out: DescribeUsersResponse = {}  # type: ignore[typeddict-item]
+    if data.get("Users") is not None:
+        import capo_workdocs.types.organization_user_list
+
+        out["users"] = capo_workdocs.types.organization_user_list.deserialize_json(
+            data["Users"]
+        )
+    if data.get("TotalNumberOfUsers") is not None:
+        out["total_number_of_users"] = data["TotalNumberOfUsers"]
+    if data.get("Marker") is not None:
+        out["marker"] = data["Marker"]
+    return out

capo_workdocs/types/document_content_type.py

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

capo_workdocs/types/document_metadata.py

@@ -0,0 +1,125 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#DocumentMetadata``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.document_version_metadata
+    import capo_workdocs.types.id_type
+    import capo_workdocs.types.resource_id_type
+    import capo_workdocs.types.resource_state_type
+    import capo_workdocs.types.shared_labels
+    import capo_workdocs.types.timestamp_type
+
+
+class DocumentMetadata(TypedDict, closed=True):
+    id: NotRequired["capo_workdocs.types.resource_id_type.ResourceIdType"]
+    """<p>The ID of the document.</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 document was created.</p>"""
+    modified_timestamp: NotRequired["capo_workdocs.types.timestamp_type.TimestampType"]
+    """<p>The time when the document was updated.</p>"""
+    latest_version_metadata: NotRequired[
+        "capo_workdocs.types.document_version_metadata.DocumentVersionMetadata"
+    ]
+    """<p>The latest version of the document.</p>"""
+    resource_state: NotRequired[
+        "capo_workdocs.types.resource_state_type.ResourceStateType"
+    ]
+    """<p>The resource state.</p>"""
+    labels: NotRequired["capo_workdocs.types.shared_labels.SharedLabels"]
+    """<p>List of labels on the document.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: DocumentMetadata) -> dict:
+    out: dict = {}
+    if "id" in value:
+        out["Id"] = value["id"]
+    if "creator_id" in value:
+        out["CreatorId"] = value["creator_id"]
+    if "parent_folder_id" in value:
+        out["ParentFolderId"] = value["parent_folder_id"]
+    if "created_timestamp" in value:
+        import capo_workdocs.types.timestamp_type
+
+        out["CreatedTimestamp"] = capo_workdocs.types.timestamp_type.serialize_json(
+            value["created_timestamp"]
+        )
+    if "modified_timestamp" in value:
+        import capo_workdocs.types.timestamp_type
+
+        out["ModifiedTimestamp"] = capo_workdocs.types.timestamp_type.serialize_json(
+            value["modified_timestamp"]
+        )
+    if "latest_version_metadata" in value:
+        import capo_workdocs.types.document_version_metadata
+
+        out["LatestVersionMetadata"] = (
+            capo_workdocs.types.document_version_metadata.serialize_json(
+                value["latest_version_metadata"]
+            )
+        )
+    if "resource_state" in value:
+        import capo_workdocs.types.resource_state_type
+
+        out["ResourceState"] = capo_workdocs.types.resource_state_type.serialize_json(
+            value["resource_state"]
+        )
+    if "labels" in value:
+        import capo_workdocs.types.shared_labels
+
+        out["Labels"] = capo_workdocs.types.shared_labels.serialize_json(
+            value["labels"]
+        )
+    return out
+
+
+def deserialize_json(data: dict) -> DocumentMetadata:
+    out: DocumentMetadata = {}  # type: ignore[typeddict-item]
+    if data.get("Id") is not None:
+        out["id"] = data["Id"]
+    if data.get("CreatorId") is not None:
+        out["creator_id"] = data["CreatorId"]
+    if data.get("ParentFolderId") is not None:
+        out["parent_folder_id"] = data["ParentFolderId"]
+    if data.get("CreatedTimestamp") is not None:
+        import capo_workdocs.types.timestamp_type
+
+        out["created_timestamp"] = capo_workdocs.types.timestamp_type.deserialize_json(
+            data["CreatedTimestamp"]
+        )
+    if data.get("ModifiedTimestamp") is not None:
+        import capo_workdocs.types.timestamp_type
+
+        out["modified_timestamp"] = capo_workdocs.types.timestamp_type.deserialize_json(
+            data["ModifiedTimestamp"]
+        )
+    if data.get("LatestVersionMetadata") is not None:
+        import capo_workdocs.types.document_version_metadata
+
+        out["latest_version_metadata"] = (
+            capo_workdocs.types.document_version_metadata.deserialize_json(
+                data["LatestVersionMetadata"]
+            )
+        )
+    if data.get("ResourceState") is not None:
+        import capo_workdocs.types.resource_state_type
+
+        out["resource_state"] = (
+            capo_workdocs.types.resource_state_type.deserialize_json(
+                data["ResourceState"]
+            )
+        )
+    if data.get("Labels") is not None:
+        import capo_workdocs.types.shared_labels
+
+        out["labels"] = capo_workdocs.types.shared_labels.deserialize_json(
+            data["Labels"]
+        )
+    return out

capo_workdocs/types/document_metadata_list.py

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

capo_workdocs/types/document_source_type.py

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

capo_workdocs/types/document_source_url_map.py

@@ -0,0 +1,33 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#DocumentSourceUrlMap``."""
+
+from typing import TYPE_CHECKING, TypeAlias
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.document_source_type
+    import capo_workdocs.types.url_type
+
+DocumentSourceUrlMap: TypeAlias = dict[
+    "capo_workdocs.types.document_source_type.DocumentSourceType",
+    "capo_workdocs.types.url_type.UrlType",
+]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(input_to_serialize: DocumentSourceUrlMap) -> dict:
+    out: dict = {}
+    for key, value in input_to_serialize.items():
+        import capo_workdocs.types.document_source_type
+
+        out[capo_workdocs.types.document_source_type.serialize_json(key)] = value
+    return out
+
+
+def deserialize_json(data: dict) -> DocumentSourceUrlMap:
+    out: DocumentSourceUrlMap = {}
+    for key, value in data.items():
+        import capo_workdocs.types.document_source_type
+
+        if value is None:
+            continue
+        out[capo_workdocs.types.document_source_type.deserialize_json(key)] = value
+    return out

capo_workdocs/types/document_status_type.py

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

capo_workdocs/types/document_thumbnail_type.py

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

capo_workdocs/types/document_thumbnail_url_map.py

@@ -0,0 +1,33 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#DocumentThumbnailUrlMap``."""
+
+from typing import TYPE_CHECKING, TypeAlias
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.document_thumbnail_type
+    import capo_workdocs.types.url_type
+
+DocumentThumbnailUrlMap: TypeAlias = dict[
+    "capo_workdocs.types.document_thumbnail_type.DocumentThumbnailType",
+    "capo_workdocs.types.url_type.UrlType",
+]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(input_to_serialize: DocumentThumbnailUrlMap) -> dict:
+    out: dict = {}
+    for key, value in input_to_serialize.items():
+        import capo_workdocs.types.document_thumbnail_type
+
+        out[capo_workdocs.types.document_thumbnail_type.serialize_json(key)] = value
+    return out
+
+
+def deserialize_json(data: dict) -> DocumentThumbnailUrlMap:
+    out: DocumentThumbnailUrlMap = {}
+    for key, value in data.items():
+        import capo_workdocs.types.document_thumbnail_type
+
+        if value is None:
+            continue
+        out[capo_workdocs.types.document_thumbnail_type.deserialize_json(key)] = value
+    return out

capo_workdocs/types/document_version_id_type.py

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