capo-workdocs 0.1.0__py3-none-any.whl

capo_workdocs/types/header_value_type.py

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

capo_workdocs/types/id_type.py

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

capo_workdocs/types/initiate_document_version_upload_request.py

@@ -0,0 +1,103 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#InitiateDocumentVersionUploadRequest``."""
+
+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.document_content_type
+    import capo_workdocs.types.resource_id_type
+    import capo_workdocs.types.resource_name_type
+    import capo_workdocs.types.size_type
+    import capo_workdocs.types.timestamp_type
+
+
+class InitiateDocumentVersionUploadRequest(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>"""
+    id: NotRequired["capo_workdocs.types.resource_id_type.ResourceIdType"]
+    """<p>The ID of the document.</p>"""
+    name: NotRequired["capo_workdocs.types.resource_name_type.ResourceNameType"]
+    """<p>The name of the document.</p>"""
+    content_created_timestamp: NotRequired[
+        "capo_workdocs.types.timestamp_type.TimestampType"
+    ]
+    """<p>The timestamp when the content of the document was originally created.</p>"""
+    content_modified_timestamp: NotRequired[
+        "capo_workdocs.types.timestamp_type.TimestampType"
+    ]
+    """<p>The timestamp when the content of the document was modified.</p>"""
+    content_type: NotRequired[
+        "capo_workdocs.types.document_content_type.DocumentContentType"
+    ]
+    """<p>The content type of the document.</p>"""
+    document_size_in_bytes: NotRequired["capo_workdocs.types.size_type.SizeType"]
+    """<p>The size of the document, in bytes.</p>"""
+    parent_folder_id: NotRequired["capo_workdocs.types.resource_id_type.ResourceIdType"]
+    """<p>The ID of the parent folder.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: InitiateDocumentVersionUploadRequest) -> dict:
+    out: dict = {}
+    if "id" in value:
+        out["Id"] = value["id"]
+    if "name" in value:
+        out["Name"] = value["name"]
+    if "content_created_timestamp" in value:
+        import capo_workdocs.types.timestamp_type
+
+        out["ContentCreatedTimestamp"] = (
+            capo_workdocs.types.timestamp_type.serialize_json(
+                value["content_created_timestamp"]
+            )
+        )
+    if "content_modified_timestamp" in value:
+        import capo_workdocs.types.timestamp_type
+
+        out["ContentModifiedTimestamp"] = (
+            capo_workdocs.types.timestamp_type.serialize_json(
+                value["content_modified_timestamp"]
+            )
+        )
+    if "content_type" in value:
+        out["ContentType"] = value["content_type"]
+    if "document_size_in_bytes" in value:
+        out["DocumentSizeInBytes"] = value["document_size_in_bytes"]
+    if "parent_folder_id" in value:
+        out["ParentFolderId"] = value["parent_folder_id"]
+    return out
+
+
+def deserialize_json(data: dict) -> InitiateDocumentVersionUploadRequest:
+    out: InitiateDocumentVersionUploadRequest = {}  # 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"]
+    if data.get("ContentCreatedTimestamp") is not None:
+        import capo_workdocs.types.timestamp_type
+
+        out["content_created_timestamp"] = (
+            capo_workdocs.types.timestamp_type.deserialize_json(
+                data["ContentCreatedTimestamp"]
+            )
+        )
+    if data.get("ContentModifiedTimestamp") is not None:
+        import capo_workdocs.types.timestamp_type
+
+        out["content_modified_timestamp"] = (
+            capo_workdocs.types.timestamp_type.deserialize_json(
+                data["ContentModifiedTimestamp"]
+            )
+        )
+    if data.get("ContentType") is not None:
+        out["content_type"] = data["ContentType"]
+    if data.get("DocumentSizeInBytes") is not None:
+        out["document_size_in_bytes"] = data["DocumentSizeInBytes"]
+    if data.get("ParentFolderId") is not None:
+        out["parent_folder_id"] = data["ParentFolderId"]
+    return out

capo_workdocs/types/initiate_document_version_upload_response.py

@@ -0,0 +1,51 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#InitiateDocumentVersionUploadResponse``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.document_metadata
+    import capo_workdocs.types.upload_metadata
+
+
+class InitiateDocumentVersionUploadResponse(TypedDict, closed=True):
+    metadata: NotRequired["capo_workdocs.types.document_metadata.DocumentMetadata"]
+    """<p>The document metadata.</p>"""
+    upload_metadata: NotRequired["capo_workdocs.types.upload_metadata.UploadMetadata"]
+    """<p>The upload metadata.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: InitiateDocumentVersionUploadResponse) -> dict:
+    out: dict = {}
+    if "metadata" in value:
+        import capo_workdocs.types.document_metadata
+
+        out["Metadata"] = capo_workdocs.types.document_metadata.serialize_json(
+            value["metadata"]
+        )
+    if "upload_metadata" in value:
+        import capo_workdocs.types.upload_metadata
+
+        out["UploadMetadata"] = capo_workdocs.types.upload_metadata.serialize_json(
+            value["upload_metadata"]
+        )
+    return out
+
+
+def deserialize_json(data: dict) -> InitiateDocumentVersionUploadResponse:
+    out: InitiateDocumentVersionUploadResponse = {}  # type: ignore[typeddict-item]
+    if data.get("Metadata") is not None:
+        import capo_workdocs.types.document_metadata
+
+        out["metadata"] = capo_workdocs.types.document_metadata.deserialize_json(
+            data["Metadata"]
+        )
+    if data.get("UploadMetadata") is not None:
+        import capo_workdocs.types.upload_metadata
+
+        out["upload_metadata"] = capo_workdocs.types.upload_metadata.deserialize_json(
+            data["UploadMetadata"]
+        )
+    return out

capo_workdocs/types/language_code_type.py

@@ -0,0 +1,46 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#LanguageCodeType``."""
+
+from typing import Literal, TypeAlias, cast
+
+LanguageCodeType: TypeAlias = Literal[
+    "AR",
+    "BG",
+    "BN",
+    "DA",
+    "DE",
+    "CS",
+    "EL",
+    "EN",
+    "ES",
+    "FA",
+    "FI",
+    "FR",
+    "HI",
+    "HU",
+    "ID",
+    "IT",
+    "JA",
+    "KO",
+    "LT",
+    "LV",
+    "NL",
+    "NO",
+    "PT",
+    "RO",
+    "RU",
+    "SV",
+    "SW",
+    "TH",
+    "TR",
+    "ZH",
+    "DEFAULT",
+]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: LanguageCodeType) -> str:
+    return value
+
+
+def deserialize_json(data: str) -> LanguageCodeType:
+    return cast(LanguageCodeType, data)

capo_workdocs/types/limit_type.py

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

capo_workdocs/types/locale_type.py

@@ -0,0 +1,26 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#LocaleType``."""
+
+from typing import Literal, TypeAlias, cast
+
+LocaleType: TypeAlias = Literal[
+    "en",
+    "fr",
+    "ko",
+    "de",
+    "es",
+    "ja",
+    "ru",
+    "zh_CN",
+    "zh_TW",
+    "pt_BR",
+    "default",
+]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: LocaleType) -> str:
+    return value
+
+
+def deserialize_json(data: str) -> LocaleType:
+    return cast(LocaleType, data)

capo_workdocs/types/long_range_type.py

@@ -0,0 +1,34 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#LongRangeType``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.long_type
+
+
+class LongRangeType(TypedDict, closed=True):
+    start_value: NotRequired["capo_workdocs.types.long_type.LongType"]
+    """<p>The size start range (in bytes).</p>"""
+    end_value: NotRequired["capo_workdocs.types.long_type.LongType"]
+    """<p>The size end range (in bytes).</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: LongRangeType) -> dict:
+    out: dict = {}
+    if "start_value" in value:
+        out["StartValue"] = value["start_value"]
+    if "end_value" in value:
+        out["EndValue"] = value["end_value"]
+    return out
+
+
+def deserialize_json(data: dict) -> LongRangeType:
+    out: LongRangeType = {}  # type: ignore[typeddict-item]
+    if data.get("StartValue") is not None:
+        out["start_value"] = data["StartValue"]
+    if data.get("EndValue") is not None:
+        out["end_value"] = data["EndValue"]
+    return out

capo_workdocs/types/long_type.py

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

capo_workdocs/types/marker_type.py

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

capo_workdocs/types/message_type.py

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

capo_workdocs/types/next_marker_type.py

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

capo_workdocs/types/notification_options.py

@@ -0,0 +1,36 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#NotificationOptions``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.boolean_type
+    import capo_workdocs.types.message_type
+
+
+class NotificationOptions(TypedDict, closed=True):
+    send_email: "capo_workdocs.types.boolean_type.BooleanType"
+    """<p>Boolean value to indicate an email notification should be sent to the recipients.</p>"""
+    email_message: NotRequired["capo_workdocs.types.message_type.MessageType"]
+    """<p>Text value to be included in the email body.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: NotificationOptions) -> dict:
+    out: dict = {}
+    out["SendEmail"] = value.get("send_email", False)
+    if "email_message" in value:
+        out["EmailMessage"] = value["email_message"]
+    return out
+
+
+def deserialize_json(data: dict) -> NotificationOptions:
+    out: NotificationOptions = {}  # type: ignore[typeddict-item]
+    if data.get("SendEmail") is not None:
+        out["send_email"] = data["SendEmail"]
+    else:
+        out["send_email"] = False
+    if data.get("EmailMessage") is not None:
+        out["email_message"] = data["EmailMessage"]
+    return out

capo_workdocs/types/order_by_field_type.py

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

capo_workdocs/types/order_type.py

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

capo_workdocs/types/organization_user_list.py

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

capo_workdocs/types/page_marker_type.py

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

capo_workdocs/types/participants.py

@@ -0,0 +1,51 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#Participants``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.group_metadata_list
+    import capo_workdocs.types.user_metadata_list
+
+
+class Participants(TypedDict, closed=True):
+    users: NotRequired["capo_workdocs.types.user_metadata_list.UserMetadataList"]
+    """<p>The list of users.</p>"""
+    groups: NotRequired["capo_workdocs.types.group_metadata_list.GroupMetadataList"]
+    """<p>The list of user groups.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: Participants) -> dict:
+    out: dict = {}
+    if "users" in value:
+        import capo_workdocs.types.user_metadata_list
+
+        out["Users"] = capo_workdocs.types.user_metadata_list.serialize_json(
+            value["users"]
+        )
+    if "groups" in value:
+        import capo_workdocs.types.group_metadata_list
+
+        out["Groups"] = capo_workdocs.types.group_metadata_list.serialize_json(
+            value["groups"]
+        )
+    return out
+
+
+def deserialize_json(data: dict) -> Participants:
+    out: Participants = {}  # type: ignore[typeddict-item]
+    if data.get("Users") is not None:
+        import capo_workdocs.types.user_metadata_list
+
+        out["users"] = capo_workdocs.types.user_metadata_list.deserialize_json(
+            data["Users"]
+        )
+    if data.get("Groups") is not None:
+        import capo_workdocs.types.group_metadata_list
+
+        out["groups"] = capo_workdocs.types.group_metadata_list.deserialize_json(
+            data["Groups"]
+        )
+    return out

capo_workdocs/types/password_type.py

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

capo_workdocs/types/permission_info.py

@@ -0,0 +1,47 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#PermissionInfo``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.role_permission_type
+    import capo_workdocs.types.role_type
+
+
+class PermissionInfo(TypedDict, closed=True):
+    role: NotRequired["capo_workdocs.types.role_type.RoleType"]
+    """<p>The role of the user.</p>"""
+    type: NotRequired["capo_workdocs.types.role_permission_type.RolePermissionType"]
+    """<p>The type of permissions.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: PermissionInfo) -> dict:
+    out: dict = {}
+    if "role" in value:
+        import capo_workdocs.types.role_type
+
+        out["Role"] = capo_workdocs.types.role_type.serialize_json(value["role"])
+    if "type" in value:
+        import capo_workdocs.types.role_permission_type
+
+        out["Type"] = capo_workdocs.types.role_permission_type.serialize_json(
+            value["type"]
+        )
+    return out
+
+
+def deserialize_json(data: dict) -> PermissionInfo:
+    out: PermissionInfo = {}  # type: ignore[typeddict-item]
+    if data.get("Role") is not None:
+        import capo_workdocs.types.role_type
+
+        out["role"] = capo_workdocs.types.role_type.deserialize_json(data["Role"])
+    if data.get("Type") is not None:
+        import capo_workdocs.types.role_permission_type
+
+        out["type"] = capo_workdocs.types.role_permission_type.deserialize_json(
+            data["Type"]
+        )
+    return out

capo_workdocs/types/permission_info_list.py

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

capo_workdocs/types/positive_integer_type.py

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

capo_workdocs/types/positive_size_type.py

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

capo_workdocs/types/principal.py

@@ -0,0 +1,54 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#Principal``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.id_type
+    import capo_workdocs.types.permission_info_list
+    import capo_workdocs.types.principal_type
+
+
+class Principal(TypedDict, closed=True):
+    id: NotRequired["capo_workdocs.types.id_type.IdType"]
+    """<p>The ID of the resource.</p>"""
+    type: NotRequired["capo_workdocs.types.principal_type.PrincipalType"]
+    """<p>The type of resource.</p>"""
+    roles: NotRequired["capo_workdocs.types.permission_info_list.PermissionInfoList"]
+    """<p>The permission information for the resource.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: Principal) -> dict:
+    out: dict = {}
+    if "id" in value:
+        out["Id"] = value["id"]
+    if "type" in value:
+        import capo_workdocs.types.principal_type
+
+        out["Type"] = capo_workdocs.types.principal_type.serialize_json(value["type"])
+    if "roles" in value:
+        import capo_workdocs.types.permission_info_list
+
+        out["Roles"] = capo_workdocs.types.permission_info_list.serialize_json(
+            value["roles"]
+        )
+    return out
+
+
+def deserialize_json(data: dict) -> Principal:
+    out: Principal = {}  # type: ignore[typeddict-item]
+    if data.get("Id") is not None:
+        out["id"] = data["Id"]
+    if data.get("Type") is not None:
+        import capo_workdocs.types.principal_type
+
+        out["type"] = capo_workdocs.types.principal_type.deserialize_json(data["Type"])
+    if data.get("Roles") is not None:
+        import capo_workdocs.types.permission_info_list
+
+        out["roles"] = capo_workdocs.types.permission_info_list.deserialize_json(
+            data["Roles"]
+        )
+    return out

capo_workdocs/types/principal_list.py

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