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

python_alfresco_api/raw_clients/alfresco_core_client/core_client/api/sites/get_site_membership.py

@@ -0,0 +1,210 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.site_member_entry import SiteMemberEntry
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    site_id: str,
+    person_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"/sites/{site_id}/members/{person_id}",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[Any, SiteMemberEntry]]:
+    if response.status_code == 200:
+        response_200 = SiteMemberEntry.from_dict(response.json())
+
+        return response_200
+    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, SiteMemberEntry]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    site_id: str,
+    person_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Response[Union[Any, SiteMemberEntry]]:
+    """Get a site membership
+
+     Gets site membership information for person **personId** on site **siteId**.
+
+    You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.
+
+    Args:
+        site_id (str):
+        person_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, SiteMemberEntry]]
+    """
+
+    kwargs = _get_kwargs(
+        site_id=site_id,
+        person_id=person_id,
+        fields=fields,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    site_id: str,
+    person_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Optional[Union[Any, SiteMemberEntry]]:
+    """Get a site membership
+
+     Gets site membership information for person **personId** on site **siteId**.
+
+    You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.
+
+    Args:
+        site_id (str):
+        person_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, SiteMemberEntry]
+    """
+
+    return sync_detailed(
+        site_id=site_id,
+        person_id=person_id,
+        client=client,
+        fields=fields,
+    ).parsed
+
+
+async def asyncio_detailed(
+    site_id: str,
+    person_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Response[Union[Any, SiteMemberEntry]]:
+    """Get a site membership
+
+     Gets site membership information for person **personId** on site **siteId**.
+
+    You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.
+
+    Args:
+        site_id (str):
+        person_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, SiteMemberEntry]]
+    """
+
+    kwargs = _get_kwargs(
+        site_id=site_id,
+        person_id=person_id,
+        fields=fields,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    site_id: str,
+    person_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Optional[Union[Any, SiteMemberEntry]]:
+    """Get a site membership
+
+     Gets site membership information for person **personId** on site **siteId**.
+
+    You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.
+
+    Args:
+        site_id (str):
+        person_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, SiteMemberEntry]
+    """
+
+    return (
+        await asyncio_detailed(
+            site_id=site_id,
+            person_id=person_id,
+            client=client,
+            fields=fields,
+        )
+    ).parsed

python_alfresco_api/raw_clients/alfresco_core_client/core_client/api/sites/get_site_membership_for_person.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(
+    person_id: str,
+    site_id: str,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": f"/people/{person_id}/sites/{site_id}",
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[Any]:
+    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(
+    person_id: str,
+    site_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Any]:
+    """Get a site membership
+
+     Gets site membership information for person **personId** on site **siteId**.
+
+    You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.
+
+    Args:
+        person_id (str):
+        site_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(
+        person_id=person_id,
+        site_id=site_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    person_id: str,
+    site_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Any]:
+    """Get a site membership
+
+     Gets site membership information for person **personId** on site **siteId**.
+
+    You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.
+
+    Args:
+        person_id (str):
+        site_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(
+        person_id=person_id,
+        site_id=site_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/sites/get_site_membership_request_for_person.py

@@ -0,0 +1,129 @@
+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(
+    person_id: str,
+    site_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"/people/{person_id}/site-membership-requests/{site_id}",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[Any]:
+    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(
+    person_id: str,
+    site_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Response[Any]:
+    """Get a site membership request
+
+     Gets the site membership request for site **siteId** for person **personId**, if one exists.
+
+    You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.
+
+    Args:
+        person_id (str):
+        site_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[Any]
+    """
+
+    kwargs = _get_kwargs(
+        person_id=person_id,
+        site_id=site_id,
+        fields=fields,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    person_id: str,
+    site_id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Response[Any]:
+    """Get a site membership request
+
+     Gets the site membership request for site **siteId** for person **personId**, if one exists.
+
+    You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.
+
+    Args:
+        person_id (str):
+        site_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[Any]
+    """
+
+    kwargs = _get_kwargs(
+        person_id=person_id,
+        site_id=site_id,
+        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/sites/get_site_membership_requests.py

@@ -0,0 +1,176 @@
+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(
+    *,
+    skip_count: Union[Unset, int] = 0,
+    max_items: Union[Unset, int] = 100,
+    where: Union[Unset, str] = UNSET,
+    fields: Union[Unset, list[str]] = UNSET,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    params["skipCount"] = skip_count
+
+    params["maxItems"] = max_items
+
+    params["where"] = where
+
+    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": "/site-membership-requests",
+        "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],
+    skip_count: Union[Unset, int] = 0,
+    max_items: Union[Unset, int] = 100,
+    where: Union[Unset, str] = UNSET,
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Response[Any]:
+    """Get site membership requests
+
+     Get the list of site membership requests the user can action.
+
+    You can use the **where** parameter to filter the returned site membership requests by **siteId**.
+    For example:
+
+    ```
+    (siteId=mySite)
+    ```
+
+    The **where** parameter can also be used to filter by ***personId***. For example:
+
+    ```
+    where=(personId=person)
+    ```
+
+    This may be combined with the siteId filter, as shown below:
+
+    ```
+    where=(siteId=mySite AND personId=person))
+    ```
+
+    Args:
+        skip_count (Union[Unset, int]):  Default: 0.
+        max_items (Union[Unset, int]):  Default: 100.
+        where (Union[Unset, 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(
+        skip_count=skip_count,
+        max_items=max_items,
+        where=where,
+        fields=fields,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    skip_count: Union[Unset, int] = 0,
+    max_items: Union[Unset, int] = 100,
+    where: Union[Unset, str] = UNSET,
+    fields: Union[Unset, list[str]] = UNSET,
+) -> Response[Any]:
+    """Get site membership requests
+
+     Get the list of site membership requests the user can action.
+
+    You can use the **where** parameter to filter the returned site membership requests by **siteId**.
+    For example:
+
+    ```
+    (siteId=mySite)
+    ```
+
+    The **where** parameter can also be used to filter by ***personId***. For example:
+
+    ```
+    where=(personId=person)
+    ```
+
+    This may be combined with the siteId filter, as shown below:
+
+    ```
+    where=(siteId=mySite AND personId=person))
+    ```
+
+    Args:
+        skip_count (Union[Unset, int]):  Default: 0.
+        max_items (Union[Unset, int]):  Default: 100.
+        where (Union[Unset, 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(
+        skip_count=skip_count,
+        max_items=max_items,
+        where=where,
+        fields=fields,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)