iter_describe_document_versions ¶

iter_describe_document_versions(
    document_id: ResourceIdType,
    *,
    config_overrides: Optional[WorkDocsClientConfig] = None,
    authentication_token: Optional[AuthenticationHeaderType] = None,
    marker: Optional[PageMarkerType] = None,
    limit: Optional[LimitType] = None,
    include: Optional[FieldNamesType] = None,
    fields: Optional[FieldNamesType] = None,
) -> Iterator[DocumentVersionMetadata]

Source code in docs_src/capo_workdocs/_services/work_docs.py

def iter_describe_document_versions(
    self,
    document_id: "capo_workdocs.types.resource_id_type.ResourceIdType",
    *,
    config_overrides: Optional[WorkDocsClientConfig] = None,
    authentication_token: Optional[
        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
    ] = None,
    marker: Optional["capo_workdocs.types.page_marker_type.PageMarkerType"] = None,
    limit: Optional["capo_workdocs.types.limit_type.LimitType"] = None,
    include: Optional["capo_workdocs.types.field_names_type.FieldNamesType"] = None,
    fields: Optional["capo_workdocs.types.field_names_type.FieldNamesType"] = None,
) -> "Iterator[capo_workdocs.types.document_version_metadata.DocumentVersionMetadata]":
    _token = marker
    while True:
        _response = self.describe_document_versions(
            document_id,
            config_overrides=config_overrides,
            authentication_token=authentication_token,
            marker=_token,
            limit=limit,
            include=include,
            fields=fields,
        )
        _page = _resolve_path(_response, ("document_versions",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("marker",))
        if not _token:
            break