capo-workdocs 0.1.0__py3-none-any.whl

capo_workdocs/types/update_user_request.py

@@ -0,0 +1,111 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#UpdateUserRequest``."""
+
+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.boolean_enum_type
+    import capo_workdocs.types.id_type
+    import capo_workdocs.types.locale_type
+    import capo_workdocs.types.storage_rule_type
+    import capo_workdocs.types.time_zone_id_type
+    import capo_workdocs.types.user_attribute_value_type
+    import capo_workdocs.types.user_type
+
+
+class UpdateUserRequest(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>"""
+    user_id: "capo_workdocs.types.id_type.IdType"
+    """<p>The ID of the user.</p>"""
+    given_name: NotRequired[
+        "capo_workdocs.types.user_attribute_value_type.UserAttributeValueType"
+    ]
+    """<p>The given name of the user.</p>"""
+    surname: NotRequired[
+        "capo_workdocs.types.user_attribute_value_type.UserAttributeValueType"
+    ]
+    """<p>The surname of the user.</p>"""
+    type: NotRequired["capo_workdocs.types.user_type.UserType"]
+    """<p>The type of the user.</p>"""
+    storage_rule: NotRequired["capo_workdocs.types.storage_rule_type.StorageRuleType"]
+    """<p>The amount of storage for the user.</p>"""
+    time_zone_id: NotRequired["capo_workdocs.types.time_zone_id_type.TimeZoneIdType"]
+    """<p>The time zone ID of the user.</p>"""
+    locale: NotRequired["capo_workdocs.types.locale_type.LocaleType"]
+    """<p>The locale of the user.</p>"""
+    grant_poweruser_privileges: NotRequired[
+        "capo_workdocs.types.boolean_enum_type.BooleanEnumType"
+    ]
+    """<p>Boolean value to determine whether the user is granted Power user privileges.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: UpdateUserRequest) -> dict:
+    out: dict = {}
+    if "given_name" in value:
+        out["GivenName"] = value["given_name"]
+    if "surname" in value:
+        out["Surname"] = value["surname"]
+    if "type" in value:
+        import capo_workdocs.types.user_type
+
+        out["Type"] = capo_workdocs.types.user_type.serialize_json(value["type"])
+    if "storage_rule" in value:
+        import capo_workdocs.types.storage_rule_type
+
+        out["StorageRule"] = capo_workdocs.types.storage_rule_type.serialize_json(
+            value["storage_rule"]
+        )
+    if "time_zone_id" in value:
+        out["TimeZoneId"] = value["time_zone_id"]
+    if "locale" in value:
+        import capo_workdocs.types.locale_type
+
+        out["Locale"] = capo_workdocs.types.locale_type.serialize_json(value["locale"])
+    if "grant_poweruser_privileges" in value:
+        import capo_workdocs.types.boolean_enum_type
+
+        out["GrantPoweruserPrivileges"] = (
+            capo_workdocs.types.boolean_enum_type.serialize_json(
+                value["grant_poweruser_privileges"]
+            )
+        )
+    return out
+
+
+def deserialize_json(data: dict) -> UpdateUserRequest:
+    out: UpdateUserRequest = {}  # type: ignore[typeddict-item]
+    if data.get("GivenName") is not None:
+        out["given_name"] = data["GivenName"]
+    if data.get("Surname") is not None:
+        out["surname"] = data["Surname"]
+    if data.get("Type") is not None:
+        import capo_workdocs.types.user_type
+
+        out["type"] = capo_workdocs.types.user_type.deserialize_json(data["Type"])
+    if data.get("StorageRule") is not None:
+        import capo_workdocs.types.storage_rule_type
+
+        out["storage_rule"] = capo_workdocs.types.storage_rule_type.deserialize_json(
+            data["StorageRule"]
+        )
+    if data.get("TimeZoneId") is not None:
+        out["time_zone_id"] = data["TimeZoneId"]
+    if data.get("Locale") is not None:
+        import capo_workdocs.types.locale_type
+
+        out["locale"] = capo_workdocs.types.locale_type.deserialize_json(data["Locale"])
+    if data.get("GrantPoweruserPrivileges") is not None:
+        import capo_workdocs.types.boolean_enum_type
+
+        out["grant_poweruser_privileges"] = (
+            capo_workdocs.types.boolean_enum_type.deserialize_json(
+                data["GrantPoweruserPrivileges"]
+            )
+        )
+    return out

capo_workdocs/types/update_user_response.py

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

capo_workdocs/types/upload_metadata.py

@@ -0,0 +1,43 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#UploadMetadata``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.signed_header_map
+    import capo_workdocs.types.url_type
+
+
+class UploadMetadata(TypedDict, closed=True):
+    upload_url: NotRequired["capo_workdocs.types.url_type.UrlType"]
+    """<p>The URL of the upload.</p>"""
+    signed_headers: NotRequired["capo_workdocs.types.signed_header_map.SignedHeaderMap"]
+    """<p>The signed headers.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: UploadMetadata) -> dict:
+    out: dict = {}
+    if "upload_url" in value:
+        out["UploadUrl"] = value["upload_url"]
+    if "signed_headers" in value:
+        import capo_workdocs.types.signed_header_map
+
+        out["SignedHeaders"] = capo_workdocs.types.signed_header_map.serialize_json(
+            value["signed_headers"]
+        )
+    return out
+
+
+def deserialize_json(data: dict) -> UploadMetadata:
+    out: UploadMetadata = {}  # type: ignore[typeddict-item]
+    if data.get("UploadUrl") is not None:
+        out["upload_url"] = data["UploadUrl"]
+    if data.get("SignedHeaders") is not None:
+        import capo_workdocs.types.signed_header_map
+
+        out["signed_headers"] = capo_workdocs.types.signed_header_map.deserialize_json(
+            data["SignedHeaders"]
+        )
+    return out

capo_workdocs/types/url_type.py

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

capo_workdocs/types/user.py

@@ -0,0 +1,172 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#User``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.email_address_type
+    import capo_workdocs.types.id_type
+    import capo_workdocs.types.locale_type
+    import capo_workdocs.types.resource_id_type
+    import capo_workdocs.types.time_zone_id_type
+    import capo_workdocs.types.timestamp_type
+    import capo_workdocs.types.user_attribute_value_type
+    import capo_workdocs.types.user_status_type
+    import capo_workdocs.types.user_storage_metadata
+    import capo_workdocs.types.user_type
+    import capo_workdocs.types.username_type
+
+
+class User(TypedDict, closed=True):
+    id: NotRequired["capo_workdocs.types.id_type.IdType"]
+    """<p>The ID of the user.</p>"""
+    username: NotRequired["capo_workdocs.types.username_type.UsernameType"]
+    """<p>The login name of the user.</p>"""
+    email_address: NotRequired[
+        "capo_workdocs.types.email_address_type.EmailAddressType"
+    ]
+    """<p>The email address of the user.</p>"""
+    given_name: NotRequired[
+        "capo_workdocs.types.user_attribute_value_type.UserAttributeValueType"
+    ]
+    """<p>The given name of the user.</p>"""
+    surname: NotRequired[
+        "capo_workdocs.types.user_attribute_value_type.UserAttributeValueType"
+    ]
+    """<p>The surname of the user.</p>"""
+    organization_id: NotRequired["capo_workdocs.types.id_type.IdType"]
+    """<p>The ID of the organization.</p>"""
+    root_folder_id: NotRequired["capo_workdocs.types.resource_id_type.ResourceIdType"]
+    """<p>The ID of the root folder.</p>"""
+    recycle_bin_folder_id: NotRequired[
+        "capo_workdocs.types.resource_id_type.ResourceIdType"
+    ]
+    """<p>The ID of the recycle bin folder.</p>"""
+    status: NotRequired["capo_workdocs.types.user_status_type.UserStatusType"]
+    """<p>The status of the user.</p>"""
+    type: NotRequired["capo_workdocs.types.user_type.UserType"]
+    """<p>The type of user.</p>"""
+    created_timestamp: NotRequired["capo_workdocs.types.timestamp_type.TimestampType"]
+    """<p>The time when the user was created.</p>"""
+    modified_timestamp: NotRequired["capo_workdocs.types.timestamp_type.TimestampType"]
+    """<p>The time when the user was modified.</p>"""
+    time_zone_id: NotRequired["capo_workdocs.types.time_zone_id_type.TimeZoneIdType"]
+    """<p>The time zone ID of the user.</p>"""
+    locale: NotRequired["capo_workdocs.types.locale_type.LocaleType"]
+    """<p>The locale of the user.</p>"""
+    storage: NotRequired[
+        "capo_workdocs.types.user_storage_metadata.UserStorageMetadata"
+    ]
+    """<p>The storage for the user.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: User) -> dict:
+    out: dict = {}
+    if "id" in value:
+        out["Id"] = value["id"]
+    if "username" in value:
+        out["Username"] = value["username"]
+    if "email_address" in value:
+        out["EmailAddress"] = value["email_address"]
+    if "given_name" in value:
+        out["GivenName"] = value["given_name"]
+    if "surname" in value:
+        out["Surname"] = value["surname"]
+    if "organization_id" in value:
+        out["OrganizationId"] = value["organization_id"]
+    if "root_folder_id" in value:
+        out["RootFolderId"] = value["root_folder_id"]
+    if "recycle_bin_folder_id" in value:
+        out["RecycleBinFolderId"] = value["recycle_bin_folder_id"]
+    if "status" in value:
+        import capo_workdocs.types.user_status_type
+
+        out["Status"] = capo_workdocs.types.user_status_type.serialize_json(
+            value["status"]
+        )
+    if "type" in value:
+        import capo_workdocs.types.user_type
+
+        out["Type"] = capo_workdocs.types.user_type.serialize_json(value["type"])
+    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 "time_zone_id" in value:
+        out["TimeZoneId"] = value["time_zone_id"]
+    if "locale" in value:
+        import capo_workdocs.types.locale_type
+
+        out["Locale"] = capo_workdocs.types.locale_type.serialize_json(value["locale"])
+    if "storage" in value:
+        import capo_workdocs.types.user_storage_metadata
+
+        out["Storage"] = capo_workdocs.types.user_storage_metadata.serialize_json(
+            value["storage"]
+        )
+    return out
+
+
+def deserialize_json(data: dict) -> User:
+    out: User = {}  # type: ignore[typeddict-item]
+    if data.get("Id") is not None:
+        out["id"] = data["Id"]
+    if data.get("Username") is not None:
+        out["username"] = data["Username"]
+    if data.get("EmailAddress") is not None:
+        out["email_address"] = data["EmailAddress"]
+    if data.get("GivenName") is not None:
+        out["given_name"] = data["GivenName"]
+    if data.get("Surname") is not None:
+        out["surname"] = data["Surname"]
+    if data.get("OrganizationId") is not None:
+        out["organization_id"] = data["OrganizationId"]
+    if data.get("RootFolderId") is not None:
+        out["root_folder_id"] = data["RootFolderId"]
+    if data.get("RecycleBinFolderId") is not None:
+        out["recycle_bin_folder_id"] = data["RecycleBinFolderId"]
+    if data.get("Status") is not None:
+        import capo_workdocs.types.user_status_type
+
+        out["status"] = capo_workdocs.types.user_status_type.deserialize_json(
+            data["Status"]
+        )
+    if data.get("Type") is not None:
+        import capo_workdocs.types.user_type
+
+        out["type"] = capo_workdocs.types.user_type.deserialize_json(data["Type"])
+    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("TimeZoneId") is not None:
+        out["time_zone_id"] = data["TimeZoneId"]
+    if data.get("Locale") is not None:
+        import capo_workdocs.types.locale_type
+
+        out["locale"] = capo_workdocs.types.locale_type.deserialize_json(data["Locale"])
+    if data.get("Storage") is not None:
+        import capo_workdocs.types.user_storage_metadata
+
+        out["storage"] = capo_workdocs.types.user_storage_metadata.deserialize_json(
+            data["Storage"]
+        )
+    return out

capo_workdocs/types/user_activities.py

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

capo_workdocs/types/user_attribute_value_type.py

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

capo_workdocs/types/user_filter_type.py

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

capo_workdocs/types/user_ids_type.py

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

capo_workdocs/types/user_metadata.py

@@ -0,0 +1,61 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#UserMetadata``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.email_address_type
+    import capo_workdocs.types.id_type
+    import capo_workdocs.types.user_attribute_value_type
+    import capo_workdocs.types.username_type
+
+
+class UserMetadata(TypedDict, closed=True):
+    id: NotRequired["capo_workdocs.types.id_type.IdType"]
+    """<p>The ID of the user.</p>"""
+    username: NotRequired["capo_workdocs.types.username_type.UsernameType"]
+    """<p>The name of the user.</p>"""
+    given_name: NotRequired[
+        "capo_workdocs.types.user_attribute_value_type.UserAttributeValueType"
+    ]
+    """<p>The given name of the user before a rename operation.</p>"""
+    surname: NotRequired[
+        "capo_workdocs.types.user_attribute_value_type.UserAttributeValueType"
+    ]
+    """<p>The surname of the user.</p>"""
+    email_address: NotRequired[
+        "capo_workdocs.types.email_address_type.EmailAddressType"
+    ]
+    """<p>The email address of the user.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: UserMetadata) -> dict:
+    out: dict = {}
+    if "id" in value:
+        out["Id"] = value["id"]
+    if "username" in value:
+        out["Username"] = value["username"]
+    if "given_name" in value:
+        out["GivenName"] = value["given_name"]
+    if "surname" in value:
+        out["Surname"] = value["surname"]
+    if "email_address" in value:
+        out["EmailAddress"] = value["email_address"]
+    return out
+
+
+def deserialize_json(data: dict) -> UserMetadata:
+    out: UserMetadata = {}  # type: ignore[typeddict-item]
+    if data.get("Id") is not None:
+        out["id"] = data["Id"]
+    if data.get("Username") is not None:
+        out["username"] = data["Username"]
+    if data.get("GivenName") is not None:
+        out["given_name"] = data["GivenName"]
+    if data.get("Surname") is not None:
+        out["surname"] = data["Surname"]
+    if data.get("EmailAddress") is not None:
+        out["email_address"] = data["EmailAddress"]
+    return out

capo_workdocs/types/user_metadata_list.py

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

capo_workdocs/types/user_sort_type.py

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

capo_workdocs/types/user_status_type.py

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

capo_workdocs/types/user_storage_metadata.py

@@ -0,0 +1,43 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#UserStorageMetadata``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.size_type
+    import capo_workdocs.types.storage_rule_type
+
+
+class UserStorageMetadata(TypedDict, closed=True):
+    storage_utilized_in_bytes: NotRequired["capo_workdocs.types.size_type.SizeType"]
+    """<p>The amount of storage used, in bytes.</p>"""
+    storage_rule: NotRequired["capo_workdocs.types.storage_rule_type.StorageRuleType"]
+    """<p>The storage for a user.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: UserStorageMetadata) -> dict:
+    out: dict = {}
+    if "storage_utilized_in_bytes" in value:
+        out["StorageUtilizedInBytes"] = value["storage_utilized_in_bytes"]
+    if "storage_rule" in value:
+        import capo_workdocs.types.storage_rule_type
+
+        out["StorageRule"] = capo_workdocs.types.storage_rule_type.serialize_json(
+            value["storage_rule"]
+        )
+    return out
+
+
+def deserialize_json(data: dict) -> UserStorageMetadata:
+    out: UserStorageMetadata = {}  # type: ignore[typeddict-item]
+    if data.get("StorageUtilizedInBytes") is not None:
+        out["storage_utilized_in_bytes"] = data["StorageUtilizedInBytes"]
+    if data.get("StorageRule") is not None:
+        import capo_workdocs.types.storage_rule_type
+
+        out["storage_rule"] = capo_workdocs.types.storage_rule_type.deserialize_json(
+            data["StorageRule"]
+        )
+    return out

capo_workdocs/types/user_type.py

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

capo_workdocs/types/username_type.py

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