polarion_rest_api_client.open_api_client.api.user_groups package

Contains endpoint functions for accessing the API

Submodules

polarion_rest_api_client.open_api_client.api.user_groups.get_user_group module

async polarion_rest_api_client.open_api_client.api.user_groups.get_user_group.asyncio(group_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | UsergroupsSingleGetResponse | None

Returns the specified User Group.

Args:

group_id (str): fields (SparseFields | Unset): include (str | Unset): revision (str | Unset):

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:

Errors | UsergroupsSingleGetResponse

async polarion_rest_api_client.open_api_client.api.user_groups.get_user_group.asyncio_detailed(group_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | UsergroupsSingleGetResponse]

Returns the specified User Group.

Args:

group_id (str): fields (SparseFields | Unset): include (str | Unset): revision (str | Unset):

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[Errors | UsergroupsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.user_groups.get_user_group.sync(group_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | UsergroupsSingleGetResponse | None

Returns the specified User Group.

Args:

group_id (str): fields (SparseFields | Unset): include (str | Unset): revision (str | Unset):

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:

Errors | UsergroupsSingleGetResponse

polarion_rest_api_client.open_api_client.api.user_groups.get_user_group.sync_detailed(group_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | UsergroupsSingleGetResponse]

Returns the specified User Group.

Args:

group_id (str): fields (SparseFields | Unset): include (str | Unset): revision (str | Unset):

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[Errors | UsergroupsSingleGetResponse]