capo-workdocs 0.1.0__py3-none-any.whl

capo_workdocs/types/search_collection_type.py

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

capo_workdocs/types/search_collection_type_list.py

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

capo_workdocs/types/search_content_category_type_list.py

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

capo_workdocs/types/search_label.py

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

capo_workdocs/types/search_label_list.py

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

capo_workdocs/types/search_marker_type.py

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

capo_workdocs/types/search_principal_role_list.py

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

capo_workdocs/types/search_principal_type.py

@@ -0,0 +1,48 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#SearchPrincipalType``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+from capo_workdocs.errors import DeserializationError
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.id_type
+    import capo_workdocs.types.search_principal_role_list
+
+
+class SearchPrincipalType(TypedDict, closed=True):
+    id: "capo_workdocs.types.id_type.IdType"
+    """<p>UserIds or GroupIds.</p>"""
+    roles: NotRequired[
+        "capo_workdocs.types.search_principal_role_list.SearchPrincipalRoleList"
+    ]
+    """<p>The Role of a User or Group.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: SearchPrincipalType) -> dict:
+    out: dict = {}
+    out["Id"] = value["id"]
+    if "roles" in value:
+        import capo_workdocs.types.search_principal_role_list
+
+        out["Roles"] = capo_workdocs.types.search_principal_role_list.serialize_json(
+            value["roles"]
+        )
+    return out
+
+
+def deserialize_json(data: dict) -> SearchPrincipalType:
+    out: SearchPrincipalType = {}  # type: ignore[typeddict-item]
+    if data.get("Id") is not None:
+        out["id"] = data["Id"]
+    else:
+        raise DeserializationError("SearchPrincipalType.id required")
+    if data.get("Roles") is not None:
+        import capo_workdocs.types.search_principal_role_list
+
+        out["roles"] = capo_workdocs.types.search_principal_role_list.deserialize_json(
+            data["Roles"]
+        )
+    return out

capo_workdocs/types/search_principal_type_list.py

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

capo_workdocs/types/search_query_scope_type.py

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

capo_workdocs/types/search_query_scope_type_list.py

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

capo_workdocs/types/search_query_type.py

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

capo_workdocs/types/search_resource_type.py

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

capo_workdocs/types/search_resource_type_list.py

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

capo_workdocs/types/search_resources_request.py

@@ -0,0 +1,126 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#SearchResourcesRequest``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.additional_response_fields_list
+    import capo_workdocs.types.authentication_header_type
+    import capo_workdocs.types.filters
+    import capo_workdocs.types.id_type
+    import capo_workdocs.types.next_marker_type
+    import capo_workdocs.types.search_query_scope_type_list
+    import capo_workdocs.types.search_query_type
+    import capo_workdocs.types.search_result_sort_list
+    import capo_workdocs.types.search_results_limit_type
+
+
+class SearchResourcesRequest(TypedDict, closed=True):
+    authentication_token: NotRequired[
+        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
+    ]
+    """<p>WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>"""
+    query_text: NotRequired["capo_workdocs.types.search_query_type.SearchQueryType"]
+    """<p>The String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.</p>"""
+    query_scopes: NotRequired[
+        "capo_workdocs.types.search_query_scope_type_list.SearchQueryScopeTypeList"
+    ]
+    """<p>Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content</p>"""
+    organization_id: NotRequired["capo_workdocs.types.id_type.IdType"]
+    """<p>Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.</p>"""
+    additional_response_fields: NotRequired[
+        "capo_workdocs.types.additional_response_fields_list.AdditionalResponseFieldsList"
+    ]
+    """<p>A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.</p>"""
+    filters: NotRequired["capo_workdocs.types.filters.Filters"]
+    """<p>Filters results based on entity metadata.</p>"""
+    order_by: NotRequired[
+        "capo_workdocs.types.search_result_sort_list.SearchResultSortList"
+    ]
+    """<p>Order by results in one or more categories.</p>"""
+    limit: NotRequired[
+        "capo_workdocs.types.search_results_limit_type.SearchResultsLimitType"
+    ]
+    """<p>Max results count per page.</p>"""
+    marker: NotRequired["capo_workdocs.types.next_marker_type.NextMarkerType"]
+    """<p>The marker for the next set of results.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: SearchResourcesRequest) -> dict:
+    out: dict = {}
+    if "query_text" in value:
+        out["QueryText"] = value["query_text"]
+    if "query_scopes" in value:
+        import capo_workdocs.types.search_query_scope_type_list
+
+        out["QueryScopes"] = (
+            capo_workdocs.types.search_query_scope_type_list.serialize_json(
+                value["query_scopes"]
+            )
+        )
+    if "organization_id" in value:
+        out["OrganizationId"] = value["organization_id"]
+    if "additional_response_fields" in value:
+        import capo_workdocs.types.additional_response_fields_list
+
+        out["AdditionalResponseFields"] = (
+            capo_workdocs.types.additional_response_fields_list.serialize_json(
+                value["additional_response_fields"]
+            )
+        )
+    if "filters" in value:
+        import capo_workdocs.types.filters
+
+        out["Filters"] = capo_workdocs.types.filters.serialize_json(value["filters"])
+    if "order_by" in value:
+        import capo_workdocs.types.search_result_sort_list
+
+        out["OrderBy"] = capo_workdocs.types.search_result_sort_list.serialize_json(
+            value["order_by"]
+        )
+    if "limit" in value:
+        out["Limit"] = value["limit"]
+    if "marker" in value:
+        out["Marker"] = value["marker"]
+    return out
+
+
+def deserialize_json(data: dict) -> SearchResourcesRequest:
+    out: SearchResourcesRequest = {}  # type: ignore[typeddict-item]
+    if data.get("QueryText") is not None:
+        out["query_text"] = data["QueryText"]
+    if data.get("QueryScopes") is not None:
+        import capo_workdocs.types.search_query_scope_type_list
+
+        out["query_scopes"] = (
+            capo_workdocs.types.search_query_scope_type_list.deserialize_json(
+                data["QueryScopes"]
+            )
+        )
+    if data.get("OrganizationId") is not None:
+        out["organization_id"] = data["OrganizationId"]
+    if data.get("AdditionalResponseFields") is not None:
+        import capo_workdocs.types.additional_response_fields_list
+
+        out["additional_response_fields"] = (
+            capo_workdocs.types.additional_response_fields_list.deserialize_json(
+                data["AdditionalResponseFields"]
+            )
+        )
+    if data.get("Filters") is not None:
+        import capo_workdocs.types.filters
+
+        out["filters"] = capo_workdocs.types.filters.deserialize_json(data["Filters"])
+    if data.get("OrderBy") is not None:
+        import capo_workdocs.types.search_result_sort_list
+
+        out["order_by"] = capo_workdocs.types.search_result_sort_list.deserialize_json(
+            data["OrderBy"]
+        )
+    if data.get("Limit") is not None:
+        out["limit"] = data["Limit"]
+    if data.get("Marker") is not None:
+        out["marker"] = data["Marker"]
+    return out

capo_workdocs/types/search_resources_response.py

@@ -0,0 +1,43 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#SearchResourcesResponse``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.next_marker_type
+    import capo_workdocs.types.response_items_list
+
+
+class SearchResourcesResponse(TypedDict, closed=True):
+    items: NotRequired["capo_workdocs.types.response_items_list.ResponseItemsList"]
+    """<p>List of Documents, Folders, Comments, and Document Versions matching the query.</p>"""
+    marker: NotRequired["capo_workdocs.types.next_marker_type.NextMarkerType"]
+    """<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: SearchResourcesResponse) -> dict:
+    out: dict = {}
+    if "items" in value:
+        import capo_workdocs.types.response_items_list
+
+        out["Items"] = capo_workdocs.types.response_items_list.serialize_json(
+            value["items"]
+        )
+    if "marker" in value:
+        out["Marker"] = value["marker"]
+    return out
+
+
+def deserialize_json(data: dict) -> SearchResourcesResponse:
+    out: SearchResourcesResponse = {}  # type: ignore[typeddict-item]
+    if data.get("Items") is not None:
+        import capo_workdocs.types.response_items_list
+
+        out["items"] = capo_workdocs.types.response_items_list.deserialize_json(
+            data["Items"]
+        )
+    if data.get("Marker") is not None:
+        out["marker"] = data["Marker"]
+    return out

capo_workdocs/types/search_result_sort_list.py

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

capo_workdocs/types/search_results_limit_type.py

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

capo_workdocs/types/search_sort_result.py

@@ -0,0 +1,47 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#SearchSortResult``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.order_by_field_type
+    import capo_workdocs.types.sort_order
+
+
+class SearchSortResult(TypedDict, closed=True):
+    field: NotRequired["capo_workdocs.types.order_by_field_type.OrderByFieldType"]
+    """<p>Sort search results based on this field name.</p>"""
+    order: NotRequired["capo_workdocs.types.sort_order.SortOrder"]
+    """<p>Sort direction.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: SearchSortResult) -> dict:
+    out: dict = {}
+    if "field" in value:
+        import capo_workdocs.types.order_by_field_type
+
+        out["Field"] = capo_workdocs.types.order_by_field_type.serialize_json(
+            value["field"]
+        )
+    if "order" in value:
+        import capo_workdocs.types.sort_order
+
+        out["Order"] = capo_workdocs.types.sort_order.serialize_json(value["order"])
+    return out
+
+
+def deserialize_json(data: dict) -> SearchSortResult:
+    out: SearchSortResult = {}  # type: ignore[typeddict-item]
+    if data.get("Field") is not None:
+        import capo_workdocs.types.order_by_field_type
+
+        out["field"] = capo_workdocs.types.order_by_field_type.deserialize_json(
+            data["Field"]
+        )
+    if data.get("Order") is not None:
+        import capo_workdocs.types.sort_order
+
+        out["order"] = capo_workdocs.types.sort_order.deserialize_json(data["Order"])
+    return out

capo_workdocs/types/share_principal.py

@@ -0,0 +1,55 @@
+"""Generated from Smithy shape ``com.amazonaws.workdocs#SharePrincipal``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import TypedDict
+
+from capo_workdocs.errors import DeserializationError
+
+if TYPE_CHECKING:
+    import capo_workdocs.types.id_type
+    import capo_workdocs.types.principal_type
+    import capo_workdocs.types.role_type
+
+
+class SharePrincipal(TypedDict, closed=True):
+    id: "capo_workdocs.types.id_type.IdType"
+    """<p>The ID of the recipient.</p>"""
+    type: "capo_workdocs.types.principal_type.PrincipalType"
+    """<p>The type of the recipient.</p>"""
+    role: "capo_workdocs.types.role_type.RoleType"
+    """<p>The role of the recipient.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: SharePrincipal) -> dict:
+    out: dict = {}
+    out["Id"] = value["id"]
+    import capo_workdocs.types.principal_type
+
+    out["Type"] = capo_workdocs.types.principal_type.serialize_json(value["type"])
+    import capo_workdocs.types.role_type
+
+    out["Role"] = capo_workdocs.types.role_type.serialize_json(value["role"])
+    return out
+
+
+def deserialize_json(data: dict) -> SharePrincipal:
+    out: SharePrincipal = {}  # type: ignore[typeddict-item]
+    if data.get("Id") is not None:
+        out["id"] = data["Id"]
+    else:
+        raise DeserializationError("SharePrincipal.id required")
+    if data.get("Type") is not None:
+        import capo_workdocs.types.principal_type
+
+        out["type"] = capo_workdocs.types.principal_type.deserialize_json(data["Type"])
+    else:
+        raise DeserializationError("SharePrincipal.type required")
+    if data.get("Role") is not None:
+        import capo_workdocs.types.role_type
+
+        out["role"] = capo_workdocs.types.role_type.deserialize_json(data["Role"])
+    else:
+        raise DeserializationError("SharePrincipal.role required")
+    return out