python-alfresco-api 1.0.0__py3-none-any.whl

python_alfresco_api/raw_clients/alfresco_core_client/core_client/api/versions/list_version_renditions.py

@@ -0,0 +1,260 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.rendition_paging import RenditionPaging
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    node_id: str,
+    version_id: str,
+    *,
+    where: Union[Unset, str] = UNSET,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    params["where"] = where
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": f"/nodes/{node_id}/versions/{version_id}/renditions",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[Any, RenditionPaging]]:
+    if response.status_code == 200:
+        response_200 = RenditionPaging.from_dict(response.json())
+
+        return response_200
+    if response.status_code == 400:
+        response_400 = cast(Any, None)
+        return response_400
+    if response.status_code == 401:
+        response_401 = cast(Any, None)
+        return response_401
+    if response.status_code == 403:
+        response_403 = cast(Any, None)
+        return response_403
+    if response.status_code == 404:
+        response_404 = cast(Any, None)
+        return response_404
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[Any, RenditionPaging]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    node_id: str,
+    version_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    where: Union[Unset, str] = UNSET,
+) -> Response[Union[Any, RenditionPaging]]:
+    """List renditions for a file version
+
+     **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions.
+
+    Gets a list of the rendition information for each rendition of the version of file **nodeId** and
+    **versionId**, including the rendition id.
+
+    Each rendition returned has a **status**: CREATED means it is available to view or download,
+    NOT_CREATED means the rendition can be requested.
+
+    You can use the **where** parameter to filter the returned renditions by **status**. For example,
+    the following **where**
+    clause will return just the CREATED renditions:
+
+    ```
+    (status='CREATED')
+    ```
+
+    Args:
+        node_id (str):
+        version_id (str):
+        where (Union[Unset, str]):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[Any, RenditionPaging]]
+    """
+
+    kwargs = _get_kwargs(
+        node_id=node_id,
+        version_id=version_id,
+        where=where,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    node_id: str,
+    version_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    where: Union[Unset, str] = UNSET,
+) -> Optional[Union[Any, RenditionPaging]]:
+    """List renditions for a file version
+
+     **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions.
+
+    Gets a list of the rendition information for each rendition of the version of file **nodeId** and
+    **versionId**, including the rendition id.
+
+    Each rendition returned has a **status**: CREATED means it is available to view or download,
+    NOT_CREATED means the rendition can be requested.
+
+    You can use the **where** parameter to filter the returned renditions by **status**. For example,
+    the following **where**
+    clause will return just the CREATED renditions:
+
+    ```
+    (status='CREATED')
+    ```
+
+    Args:
+        node_id (str):
+        version_id (str):
+        where (Union[Unset, str]):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[Any, RenditionPaging]
+    """
+
+    return sync_detailed(
+        node_id=node_id,
+        version_id=version_id,
+        client=client,
+        where=where,
+    ).parsed
+
+
+async def asyncio_detailed(
+    node_id: str,
+    version_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    where: Union[Unset, str] = UNSET,
+) -> Response[Union[Any, RenditionPaging]]:
+    """List renditions for a file version
+
+     **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions.
+
+    Gets a list of the rendition information for each rendition of the version of file **nodeId** and
+    **versionId**, including the rendition id.
+
+    Each rendition returned has a **status**: CREATED means it is available to view or download,
+    NOT_CREATED means the rendition can be requested.
+
+    You can use the **where** parameter to filter the returned renditions by **status**. For example,
+    the following **where**
+    clause will return just the CREATED renditions:
+
+    ```
+    (status='CREATED')
+    ```
+
+    Args:
+        node_id (str):
+        version_id (str):
+        where (Union[Unset, str]):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[Any, RenditionPaging]]
+    """
+
+    kwargs = _get_kwargs(
+        node_id=node_id,
+        version_id=version_id,
+        where=where,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    node_id: str,
+    version_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    where: Union[Unset, str] = UNSET,
+) -> Optional[Union[Any, RenditionPaging]]:
+    """List renditions for a file version
+
+     **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions.
+
+    Gets a list of the rendition information for each rendition of the version of file **nodeId** and
+    **versionId**, including the rendition id.
+
+    Each rendition returned has a **status**: CREATED means it is available to view or download,
+    NOT_CREATED means the rendition can be requested.
+
+    You can use the **where** parameter to filter the returned renditions by **status**. For example,
+    the following **where**
+    clause will return just the CREATED renditions:
+
+    ```
+    (status='CREATED')
+    ```
+
+    Args:
+        node_id (str):
+        version_id (str):
+        where (Union[Unset, str]):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[Any, RenditionPaging]
+    """
+
+    return (
+        await asyncio_detailed(
+            node_id=node_id,
+            version_id=version_id,
+            client=client,
+            where=where,
+        )
+    ).parsed

python_alfresco_api/raw_clients/alfresco_core_client/core_client/api/versions/revert_version.py

@@ -0,0 +1,252 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.revert_body import RevertBody
+from ...models.version_entry import VersionEntry
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    node_id: str,
+    version_id: str,
+    *,
+    body: RevertBody,
+    fields: Union[Unset, list[str]] = UNSET,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    params: dict[str, Any] = {}
+
+    json_fields: Union[Unset, list[str]] = UNSET
+    if not isinstance(fields, Unset):
+        json_fields = fields
+
+    params["fields"] = json_fields
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": f"/nodes/{node_id}/versions/{version_id}/revert",
+        "params": params,
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[Any, VersionEntry]]:
+    if response.status_code == 200:
+        response_200 = VersionEntry.from_dict(response.json())
+
+        return response_200
+    if response.status_code == 400:
+        response_400 = cast(Any, None)
+        return response_400
+    if response.status_code == 401:
+        response_401 = cast(Any, None)
+        return response_401
+    if response.status_code == 403:
+        response_403 = cast(Any, None)
+        return response_403
+    if response.status_code == 404:
+        response_404 = cast(Any, None)
+        return response_404
+    if response.status_code == 422:
+        response_422 = cast(Any, None)
+        return response_422
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[Any, VersionEntry]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    node_id: str,
+    version_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: RevertBody,
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Response[Union[Any, VersionEntry]]:
+    """Revert a version
+
+     **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
+
+    Attempts to revert the version identified by **versionId** and **nodeId** to the live node.
+
+    If the node is successfully reverted then the content and metadata for that versioned node
+    will be promoted to the live node and a new version will appear in the version history.
+
+    Args:
+        node_id (str):
+        version_id (str):
+        fields (Union[Unset, list[str]]):
+        body (RevertBody):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[Any, VersionEntry]]
+    """
+
+    kwargs = _get_kwargs(
+        node_id=node_id,
+        version_id=version_id,
+        body=body,
+        fields=fields,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    node_id: str,
+    version_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: RevertBody,
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Optional[Union[Any, VersionEntry]]:
+    """Revert a version
+
+     **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
+
+    Attempts to revert the version identified by **versionId** and **nodeId** to the live node.
+
+    If the node is successfully reverted then the content and metadata for that versioned node
+    will be promoted to the live node and a new version will appear in the version history.
+
+    Args:
+        node_id (str):
+        version_id (str):
+        fields (Union[Unset, list[str]]):
+        body (RevertBody):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[Any, VersionEntry]
+    """
+
+    return sync_detailed(
+        node_id=node_id,
+        version_id=version_id,
+        client=client,
+        body=body,
+        fields=fields,
+    ).parsed
+
+
+async def asyncio_detailed(
+    node_id: str,
+    version_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: RevertBody,
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Response[Union[Any, VersionEntry]]:
+    """Revert a version
+
+     **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
+
+    Attempts to revert the version identified by **versionId** and **nodeId** to the live node.
+
+    If the node is successfully reverted then the content and metadata for that versioned node
+    will be promoted to the live node and a new version will appear in the version history.
+
+    Args:
+        node_id (str):
+        version_id (str):
+        fields (Union[Unset, list[str]]):
+        body (RevertBody):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[Any, VersionEntry]]
+    """
+
+    kwargs = _get_kwargs(
+        node_id=node_id,
+        version_id=version_id,
+        body=body,
+        fields=fields,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    node_id: str,
+    version_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: RevertBody,
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Optional[Union[Any, VersionEntry]]:
+    """Revert a version
+
+     **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
+
+    Attempts to revert the version identified by **versionId** and **nodeId** to the live node.
+
+    If the node is successfully reverted then the content and metadata for that versioned node
+    will be promoted to the live node and a new version will appear in the version history.
+
+    Args:
+        node_id (str):
+        version_id (str):
+        fields (Union[Unset, list[str]]):
+        body (RevertBody):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[Any, VersionEntry]
+    """
+
+    return (
+        await asyncio_detailed(
+            node_id=node_id,
+            version_id=version_id,
+            client=client,
+            body=body,
+            fields=fields,
+        )
+    ).parsed