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

python_alfresco_api/raw_clients/alfresco_core_client/core_client/api/actions/action_exec.py

@@ -0,0 +1,384 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.action_body_exec import ActionBodyExec
+from ...models.action_exec_result_entry import ActionExecResultEntry
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: ActionBodyExec,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/action-executions",
+    }
+
+    _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[ActionExecResultEntry, Any]]:
+    if response.status_code == 202:
+        response_202 = ActionExecResultEntry.from_dict(response.json())
+
+        return response_202
+    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 == 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[ActionExecResultEntry, Any]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: ActionBodyExec,
+) -> Response[Union[ActionExecResultEntry, Any]]:
+    r"""Execute an action
+
+     **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
+
+    Executes an action
+
+    An action may be executed against a node specified by **targetId**. For example:
+
+    ```
+    {
+      \"actionDefinitionId\": \"copy\",
+      \"targetId\": \"4c4b3c43-f18b-43ff-af84-751f16f1ddfd\",
+      \"params\": {
+        \"destination-folder\": \"34219f79-66fa-4ebf-b371-118598af898c\"
+      }
+    }
+    ```
+
+    Performing a POST with the request body shown above will result in the node identified by
+    ```targetId```
+    being copied to the destination folder specified in the ```params``` object by the key
+    ```destination-folder```.
+
+    **targetId** is optional, however, currently **targetId** must be a valid node ID.
+    In the future, actions may be executed against different entity types or
+    executed without the need for the context of an entity.
+
+
+    Parameters supplied to the action within the ```params``` object will be converted to the expected
+    type,
+    where possible using the DefaultTypeConverter class. In addition:
+
+    * Node IDs may be supplied in their short form (implicit workspace://SpacesStore prefix)
+    * Aspect names may be supplied using their short form, e.g. cm:versionable or cm:auditable
+
+    In this example, we add the aspect ```cm:versionable``` to a node using the QName resolution
+    mentioned above:
+
+    ```
+    {
+      \"actionDefinitionId\": \"add-features\",
+      \"targetId\": \"16349e3f-2977-44d1-93f2-73c12b8083b5\",
+      \"params\": {
+        \"aspect-name\": \"cm:versionable\"
+      }
+    }
+    ```
+
+    The ```actionDefinitionId``` is the ```id``` of an action definition as returned by
+    the _list actions_ operations (e.g. GET /action-definitions).
+
+    The action will be executed **asynchronously** with a `202` HTTP response signifying that
+    the request has been accepted successfully. The response body contains the unique ID of the action
+    pending execution. The ID may be used, for example to correlate an execution with output in the
+    server logs.
+
+    Args:
+        body (ActionBodyExec):
+
+    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[ActionExecResultEntry, Any]]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: ActionBodyExec,
+) -> Optional[Union[ActionExecResultEntry, Any]]:
+    r"""Execute an action
+
+     **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
+
+    Executes an action
+
+    An action may be executed against a node specified by **targetId**. For example:
+
+    ```
+    {
+      \"actionDefinitionId\": \"copy\",
+      \"targetId\": \"4c4b3c43-f18b-43ff-af84-751f16f1ddfd\",
+      \"params\": {
+        \"destination-folder\": \"34219f79-66fa-4ebf-b371-118598af898c\"
+      }
+    }
+    ```
+
+    Performing a POST with the request body shown above will result in the node identified by
+    ```targetId```
+    being copied to the destination folder specified in the ```params``` object by the key
+    ```destination-folder```.
+
+    **targetId** is optional, however, currently **targetId** must be a valid node ID.
+    In the future, actions may be executed against different entity types or
+    executed without the need for the context of an entity.
+
+
+    Parameters supplied to the action within the ```params``` object will be converted to the expected
+    type,
+    where possible using the DefaultTypeConverter class. In addition:
+
+    * Node IDs may be supplied in their short form (implicit workspace://SpacesStore prefix)
+    * Aspect names may be supplied using their short form, e.g. cm:versionable or cm:auditable
+
+    In this example, we add the aspect ```cm:versionable``` to a node using the QName resolution
+    mentioned above:
+
+    ```
+    {
+      \"actionDefinitionId\": \"add-features\",
+      \"targetId\": \"16349e3f-2977-44d1-93f2-73c12b8083b5\",
+      \"params\": {
+        \"aspect-name\": \"cm:versionable\"
+      }
+    }
+    ```
+
+    The ```actionDefinitionId``` is the ```id``` of an action definition as returned by
+    the _list actions_ operations (e.g. GET /action-definitions).
+
+    The action will be executed **asynchronously** with a `202` HTTP response signifying that
+    the request has been accepted successfully. The response body contains the unique ID of the action
+    pending execution. The ID may be used, for example to correlate an execution with output in the
+    server logs.
+
+    Args:
+        body (ActionBodyExec):
+
+    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[ActionExecResultEntry, Any]
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: ActionBodyExec,
+) -> Response[Union[ActionExecResultEntry, Any]]:
+    r"""Execute an action
+
+     **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
+
+    Executes an action
+
+    An action may be executed against a node specified by **targetId**. For example:
+
+    ```
+    {
+      \"actionDefinitionId\": \"copy\",
+      \"targetId\": \"4c4b3c43-f18b-43ff-af84-751f16f1ddfd\",
+      \"params\": {
+        \"destination-folder\": \"34219f79-66fa-4ebf-b371-118598af898c\"
+      }
+    }
+    ```
+
+    Performing a POST with the request body shown above will result in the node identified by
+    ```targetId```
+    being copied to the destination folder specified in the ```params``` object by the key
+    ```destination-folder```.
+
+    **targetId** is optional, however, currently **targetId** must be a valid node ID.
+    In the future, actions may be executed against different entity types or
+    executed without the need for the context of an entity.
+
+
+    Parameters supplied to the action within the ```params``` object will be converted to the expected
+    type,
+    where possible using the DefaultTypeConverter class. In addition:
+
+    * Node IDs may be supplied in their short form (implicit workspace://SpacesStore prefix)
+    * Aspect names may be supplied using their short form, e.g. cm:versionable or cm:auditable
+
+    In this example, we add the aspect ```cm:versionable``` to a node using the QName resolution
+    mentioned above:
+
+    ```
+    {
+      \"actionDefinitionId\": \"add-features\",
+      \"targetId\": \"16349e3f-2977-44d1-93f2-73c12b8083b5\",
+      \"params\": {
+        \"aspect-name\": \"cm:versionable\"
+      }
+    }
+    ```
+
+    The ```actionDefinitionId``` is the ```id``` of an action definition as returned by
+    the _list actions_ operations (e.g. GET /action-definitions).
+
+    The action will be executed **asynchronously** with a `202` HTTP response signifying that
+    the request has been accepted successfully. The response body contains the unique ID of the action
+    pending execution. The ID may be used, for example to correlate an execution with output in the
+    server logs.
+
+    Args:
+        body (ActionBodyExec):
+
+    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[ActionExecResultEntry, Any]]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: ActionBodyExec,
+) -> Optional[Union[ActionExecResultEntry, Any]]:
+    r"""Execute an action
+
+     **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
+
+    Executes an action
+
+    An action may be executed against a node specified by **targetId**. For example:
+
+    ```
+    {
+      \"actionDefinitionId\": \"copy\",
+      \"targetId\": \"4c4b3c43-f18b-43ff-af84-751f16f1ddfd\",
+      \"params\": {
+        \"destination-folder\": \"34219f79-66fa-4ebf-b371-118598af898c\"
+      }
+    }
+    ```
+
+    Performing a POST with the request body shown above will result in the node identified by
+    ```targetId```
+    being copied to the destination folder specified in the ```params``` object by the key
+    ```destination-folder```.
+
+    **targetId** is optional, however, currently **targetId** must be a valid node ID.
+    In the future, actions may be executed against different entity types or
+    executed without the need for the context of an entity.
+
+
+    Parameters supplied to the action within the ```params``` object will be converted to the expected
+    type,
+    where possible using the DefaultTypeConverter class. In addition:
+
+    * Node IDs may be supplied in their short form (implicit workspace://SpacesStore prefix)
+    * Aspect names may be supplied using their short form, e.g. cm:versionable or cm:auditable
+
+    In this example, we add the aspect ```cm:versionable``` to a node using the QName resolution
+    mentioned above:
+
+    ```
+    {
+      \"actionDefinitionId\": \"add-features\",
+      \"targetId\": \"16349e3f-2977-44d1-93f2-73c12b8083b5\",
+      \"params\": {
+        \"aspect-name\": \"cm:versionable\"
+      }
+    }
+    ```
+
+    The ```actionDefinitionId``` is the ```id``` of an action definition as returned by
+    the _list actions_ operations (e.g. GET /action-definitions).
+
+    The action will be executed **asynchronously** with a `202` HTTP response signifying that
+    the request has been accepted successfully. The response body contains the unique ID of the action
+    pending execution. The ID may be used, for example to correlate an execution with output in the
+    server logs.
+
+    Args:
+        body (ActionBodyExec):
+
+    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[ActionExecResultEntry, Any]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

python_alfresco_api/raw_clients/alfresco_core_client/core_client/api/actions/list_actions.py

@@ -0,0 +1,261 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.action_definition_list import ActionDefinitionList
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    skip_count: Union[Unset, int] = 0,
+    max_items: Union[Unset, int] = 100,
+    order_by: Union[Unset, list[str]] = UNSET,
+    fields: Union[Unset, list[str]] = UNSET,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    params["skipCount"] = skip_count
+
+    params["maxItems"] = max_items
+
+    json_order_by: Union[Unset, list[str]] = UNSET
+    if not isinstance(order_by, Unset):
+        json_order_by = order_by
+
+    params["orderBy"] = json_order_by
+
+    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": "get",
+        "url": "/action-definitions",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[ActionDefinitionList, Any]]:
+    if response.status_code == 200:
+        response_200 = ActionDefinitionList.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 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[ActionDefinitionList, Any]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    skip_count: Union[Unset, int] = 0,
+    max_items: Union[Unset, int] = 100,
+    order_by: Union[Unset, list[str]] = UNSET,
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Response[Union[ActionDefinitionList, Any]]:
+    """Retrieve list of available actions
+
+     **Note:** this endpoint is available in Alfresco 5.2.2 and newer versions.
+
+    Gets a list of all available actions
+
+    The default sort order for the returned list is for actions to be sorted by ascending name.
+    You can override the default by using the **orderBy** parameter.
+
+    You can use any of the following fields to order the results:
+    * name
+    * title
+
+    Args:
+        skip_count (Union[Unset, int]):  Default: 0.
+        max_items (Union[Unset, int]):  Default: 100.
+        order_by (Union[Unset, list[str]]):
+        fields (Union[Unset, list[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[ActionDefinitionList, Any]]
+    """
+
+    kwargs = _get_kwargs(
+        skip_count=skip_count,
+        max_items=max_items,
+        order_by=order_by,
+        fields=fields,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    skip_count: Union[Unset, int] = 0,
+    max_items: Union[Unset, int] = 100,
+    order_by: Union[Unset, list[str]] = UNSET,
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Optional[Union[ActionDefinitionList, Any]]:
+    """Retrieve list of available actions
+
+     **Note:** this endpoint is available in Alfresco 5.2.2 and newer versions.
+
+    Gets a list of all available actions
+
+    The default sort order for the returned list is for actions to be sorted by ascending name.
+    You can override the default by using the **orderBy** parameter.
+
+    You can use any of the following fields to order the results:
+    * name
+    * title
+
+    Args:
+        skip_count (Union[Unset, int]):  Default: 0.
+        max_items (Union[Unset, int]):  Default: 100.
+        order_by (Union[Unset, list[str]]):
+        fields (Union[Unset, list[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[ActionDefinitionList, Any]
+    """
+
+    return sync_detailed(
+        client=client,
+        skip_count=skip_count,
+        max_items=max_items,
+        order_by=order_by,
+        fields=fields,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    skip_count: Union[Unset, int] = 0,
+    max_items: Union[Unset, int] = 100,
+    order_by: Union[Unset, list[str]] = UNSET,
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Response[Union[ActionDefinitionList, Any]]:
+    """Retrieve list of available actions
+
+     **Note:** this endpoint is available in Alfresco 5.2.2 and newer versions.
+
+    Gets a list of all available actions
+
+    The default sort order for the returned list is for actions to be sorted by ascending name.
+    You can override the default by using the **orderBy** parameter.
+
+    You can use any of the following fields to order the results:
+    * name
+    * title
+
+    Args:
+        skip_count (Union[Unset, int]):  Default: 0.
+        max_items (Union[Unset, int]):  Default: 100.
+        order_by (Union[Unset, list[str]]):
+        fields (Union[Unset, list[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[ActionDefinitionList, Any]]
+    """
+
+    kwargs = _get_kwargs(
+        skip_count=skip_count,
+        max_items=max_items,
+        order_by=order_by,
+        fields=fields,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    skip_count: Union[Unset, int] = 0,
+    max_items: Union[Unset, int] = 100,
+    order_by: Union[Unset, list[str]] = UNSET,
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Optional[Union[ActionDefinitionList, Any]]:
+    """Retrieve list of available actions
+
+     **Note:** this endpoint is available in Alfresco 5.2.2 and newer versions.
+
+    Gets a list of all available actions
+
+    The default sort order for the returned list is for actions to be sorted by ascending name.
+    You can override the default by using the **orderBy** parameter.
+
+    You can use any of the following fields to order the results:
+    * name
+    * title
+
+    Args:
+        skip_count (Union[Unset, int]):  Default: 0.
+        max_items (Union[Unset, int]):  Default: 100.
+        order_by (Union[Unset, list[str]]):
+        fields (Union[Unset, list[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[ActionDefinitionList, Any]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            skip_count=skip_count,
+            max_items=max_items,
+            order_by=order_by,
+            fields=fields,
+        )
+    ).parsed