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

python_alfresco_api/raw_clients/alfresco_core_client/core_client/api/queries/find_sites.py

@@ -0,0 +1,181 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    term: str,
+    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["term"] = term
+
+    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": "/queries/sites",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[Any]:
+    if response.status_code == 400:
+        return None
+    if response.status_code == 401:
+        return None
+    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[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],
+    term: str,
+    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[Any]:
+    """Find sites
+
+     **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
+
+    Gets a list of sites that match the given search criteria.
+
+    The search term is used to look for sites that match against site id, title or description.
+
+    The search term:
+    - must contain a minimum of 2 alphanumeric characters
+    - can optionally use '*' for wildcard matching within the term
+
+    The default sort order for the returned list is for sites to be sorted by ascending id.
+    You can override the default by using the **orderBy** parameter. You can specify one or more of the
+    following fields in the **orderBy** parameter:
+    * id
+    * title
+    * description
+
+    Args:
+        term (str):
+        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[Any]
+    """
+
+    kwargs = _get_kwargs(
+        term=term,
+        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)
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    term: str,
+    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[Any]:
+    """Find sites
+
+     **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
+
+    Gets a list of sites that match the given search criteria.
+
+    The search term is used to look for sites that match against site id, title or description.
+
+    The search term:
+    - must contain a minimum of 2 alphanumeric characters
+    - can optionally use '*' for wildcard matching within the term
+
+    The default sort order for the returned list is for sites to be sorted by ascending id.
+    You can override the default by using the **orderBy** parameter. You can specify one or more of the
+    following fields in the **orderBy** parameter:
+    * id
+    * title
+    * description
+
+    Args:
+        term (str):
+        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[Any]
+    """
+
+    kwargs = _get_kwargs(
+        term=term,
+        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)

python_alfresco_api/raw_clients/alfresco_core_client/core_client/api/ratings/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

python_alfresco_api/raw_clients/alfresco_core_client/core_client/api/ratings/create_rating.py

@@ -0,0 +1,216 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.rating_body import RatingBody
+from ...models.rating_entry import RatingEntry
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    node_id: str,
+    *,
+    body: RatingBody,
+    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}/ratings",
+        "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, RatingEntry]]:
+    if response.status_code == 201:
+        response_201 = RatingEntry.from_dict(response.json())
+
+        return response_201
+    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 response.status_code == 405:
+        response_405 = cast(Any, None)
+        return response_405
+    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, RatingEntry]]:
+    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,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: RatingBody,
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Response[Union[Any, RatingEntry]]:
+    """Create a rating
+
+     Create a rating for the node with identifier **nodeId**
+
+    Args:
+        node_id (str):
+        fields (Union[Unset, list[str]]):
+        body (RatingBody):
+
+    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, RatingEntry]]
+    """
+
+    kwargs = _get_kwargs(
+        node_id=node_id,
+        body=body,
+        fields=fields,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    node_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: RatingBody,
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Optional[Union[Any, RatingEntry]]:
+    """Create a rating
+
+     Create a rating for the node with identifier **nodeId**
+
+    Args:
+        node_id (str):
+        fields (Union[Unset, list[str]]):
+        body (RatingBody):
+
+    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, RatingEntry]
+    """
+
+    return sync_detailed(
+        node_id=node_id,
+        client=client,
+        body=body,
+        fields=fields,
+    ).parsed
+
+
+async def asyncio_detailed(
+    node_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: RatingBody,
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Response[Union[Any, RatingEntry]]:
+    """Create a rating
+
+     Create a rating for the node with identifier **nodeId**
+
+    Args:
+        node_id (str):
+        fields (Union[Unset, list[str]]):
+        body (RatingBody):
+
+    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, RatingEntry]]
+    """
+
+    kwargs = _get_kwargs(
+        node_id=node_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,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: RatingBody,
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Optional[Union[Any, RatingEntry]]:
+    """Create a rating
+
+     Create a rating for the node with identifier **nodeId**
+
+    Args:
+        node_id (str):
+        fields (Union[Unset, list[str]]):
+        body (RatingBody):
+
+    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, RatingEntry]
+    """
+
+    return (
+        await asyncio_detailed(
+            node_id=node_id,
+            client=client,
+            body=body,
+            fields=fields,
+        )
+    ).parsed

python_alfresco_api/raw_clients/alfresco_core_client/core_client/api/ratings/delete_rating.py

@@ -0,0 +1,110 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...types import Response
+
+
+def _get_kwargs(
+    node_id: str,
+    rating_id: str,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "delete",
+        "url": f"/nodes/{node_id}/ratings/{rating_id}",
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[Any]:
+    if response.status_code == 204:
+        return None
+    if response.status_code == 400:
+        return None
+    if response.status_code == 401:
+        return None
+    if response.status_code == 404:
+        return None
+    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[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(
+    node_id: str,
+    rating_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Any]:
+    """Delete a rating
+
+     Deletes rating **ratingId** from node **nodeId**.
+
+    Args:
+        node_id (str):
+        rating_id (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[Any]
+    """
+
+    kwargs = _get_kwargs(
+        node_id=node_id,
+        rating_id=rating_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    node_id: str,
+    rating_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Any]:
+    """Delete a rating
+
+     Deletes rating **ratingId** from node **nodeId**.
+
+    Args:
+        node_id (str):
+        rating_id (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[Any]
+    """
+
+    kwargs = _get_kwargs(
+        node_id=node_id,
+        rating_id=rating_id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)

python_alfresco_api/raw_clients/alfresco_core_client/core_client/api/ratings/get_rating.py

@@ -0,0 +1,205 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.rating_entry import RatingEntry
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    node_id: str,
+    rating_id: str,
+    *,
+    fields: Union[Unset, list[str]] = UNSET,
+) -> 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": "get",
+        "url": f"/nodes/{node_id}/ratings/{rating_id}",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[Any, RatingEntry]]:
+    if response.status_code == 200:
+        response_200 = RatingEntry.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 == 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, RatingEntry]]:
+    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,
+    rating_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Response[Union[Any, RatingEntry]]:
+    """Get a rating
+
+     Get the specific rating **ratingId** on node **nodeId**.
+
+    Args:
+        node_id (str):
+        rating_id (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[Any, RatingEntry]]
+    """
+
+    kwargs = _get_kwargs(
+        node_id=node_id,
+        rating_id=rating_id,
+        fields=fields,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    node_id: str,
+    rating_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Optional[Union[Any, RatingEntry]]:
+    """Get a rating
+
+     Get the specific rating **ratingId** on node **nodeId**.
+
+    Args:
+        node_id (str):
+        rating_id (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[Any, RatingEntry]
+    """
+
+    return sync_detailed(
+        node_id=node_id,
+        rating_id=rating_id,
+        client=client,
+        fields=fields,
+    ).parsed
+
+
+async def asyncio_detailed(
+    node_id: str,
+    rating_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Response[Union[Any, RatingEntry]]:
+    """Get a rating
+
+     Get the specific rating **ratingId** on node **nodeId**.
+
+    Args:
+        node_id (str):
+        rating_id (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[Any, RatingEntry]]
+    """
+
+    kwargs = _get_kwargs(
+        node_id=node_id,
+        rating_id=rating_id,
+        fields=fields,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    node_id: str,
+    rating_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Optional[Union[Any, RatingEntry]]:
+    """Get a rating
+
+     Get the specific rating **ratingId** on node **nodeId**.
+
+    Args:
+        node_id (str):
+        rating_id (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[Any, RatingEntry]
+    """
+
+    return (
+        await asyncio_detailed(
+            node_id=node_id,
+            rating_id=rating_id,
+            client=client,
+            fields=fields,
+        )
+    ).parsed