polarion_rest_api_client.open_api_client.api.users package

Contains endpoint functions for accessing the API

Submodules

polarion_rest_api_client.open_api_client.api.users.get_avatar module

async polarion_rest_api_client.open_api_client.api.users.get_avatar.asyncio(user_id: str, *, client: AuthenticatedClient | Client) → Any | Errors | None

Returns the specified User Avatar.

Args:

user_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:

Any | Errors

async polarion_rest_api_client.open_api_client.api.users.get_avatar.asyncio_detailed(user_id: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]

Returns the specified User Avatar.

Args:

user_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 | Errors]

polarion_rest_api_client.open_api_client.api.users.get_avatar.sync(user_id: str, *, client: AuthenticatedClient | Client) → Any | Errors | None

Returns the specified User Avatar.

Args:

user_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:

Any | Errors

polarion_rest_api_client.open_api_client.api.users.get_avatar.sync_detailed(user_id: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]

Returns the specified User Avatar.

Args:

user_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 | Errors]

polarion_rest_api_client.open_api_client.api.users.get_current_user module

async polarion_rest_api_client.open_api_client.api.users.get_current_user.asyncio(*, 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 | UsersSingleGetResponse | None

Returns the current User.

Args:

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 | UsersSingleGetResponse

async polarion_rest_api_client.open_api_client.api.users.get_current_user.asyncio_detailed(*, 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 | UsersSingleGetResponse]

Returns the current User.

Args:

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 | UsersSingleGetResponse]

polarion_rest_api_client.open_api_client.api.users.get_current_user.sync(*, 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 | UsersSingleGetResponse | None

Returns the current User.

Args:

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 | UsersSingleGetResponse

polarion_rest_api_client.open_api_client.api.users.get_current_user.sync_detailed(*, 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 | UsersSingleGetResponse]

Returns the current User.

Args:

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 | UsersSingleGetResponse]

polarion_rest_api_client.open_api_client.api.users.get_user module

async polarion_rest_api_client.open_api_client.api.users.get_user.asyncio(user_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 | UsersSingleGetResponse | None

Returns the specified User.

Args:

user_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 | UsersSingleGetResponse

async polarion_rest_api_client.open_api_client.api.users.get_user.asyncio_detailed(user_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 | UsersSingleGetResponse]

Returns the specified User.

Args:

user_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 | UsersSingleGetResponse]

polarion_rest_api_client.open_api_client.api.users.get_user.sync(user_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 | UsersSingleGetResponse | None

Returns the specified User.

Args:

user_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 | UsersSingleGetResponse

polarion_rest_api_client.open_api_client.api.users.get_user.sync_detailed(user_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 | UsersSingleGetResponse]

Returns the specified User.

Args:

user_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 | UsersSingleGetResponse]

polarion_rest_api_client.open_api_client.api.users.get_users module

async polarion_rest_api_client.open_api_client.api.users.get_users.asyncio(*, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, 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>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: 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 | UsersListGetResponse | None

Returns a list of Users.

Args:

pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (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 | UsersListGetResponse

async polarion_rest_api_client.open_api_client.api.users.get_users.asyncio_detailed(*, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, 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>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: 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 | UsersListGetResponse]

Returns a list of Users.

Args:

pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (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 | UsersListGetResponse]

polarion_rest_api_client.open_api_client.api.users.get_users.sync(*, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, 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>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: 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 | UsersListGetResponse | None

Returns a list of Users.

Args:

pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (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 | UsersListGetResponse

polarion_rest_api_client.open_api_client.api.users.get_users.sync_detailed(*, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, 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>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: 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 | UsersListGetResponse]

Returns a list of Users.

Args:

pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (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 | UsersListGetResponse]

polarion_rest_api_client.open_api_client.api.users.patch_user module

async polarion_rest_api_client.open_api_client.api.users.patch_user.asyncio(user_id: str, *, client: AuthenticatedClient | Client, body: UsersSinglePatchRequest) → Any | Errors | None

Updates the specified User.

Args:

user_id (str): body (UsersSinglePatchRequest):

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:

Any | Errors

async polarion_rest_api_client.open_api_client.api.users.patch_user.asyncio_detailed(user_id: str, *, client: AuthenticatedClient | Client, body: UsersSinglePatchRequest) → Response[Any | Errors]

Updates the specified User.

Args:

user_id (str): body (UsersSinglePatchRequest):

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

polarion_rest_api_client.open_api_client.api.users.patch_user.sync(user_id: str, *, client: AuthenticatedClient | Client, body: UsersSinglePatchRequest) → Any | Errors | None

Updates the specified User.

Args:

user_id (str): body (UsersSinglePatchRequest):

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:

Any | Errors

polarion_rest_api_client.open_api_client.api.users.patch_user.sync_detailed(user_id: str, *, client: AuthenticatedClient | Client, body: UsersSinglePatchRequest) → Response[Any | Errors]

Updates the specified User.

Args:

user_id (str): body (UsersSinglePatchRequest):

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

polarion_rest_api_client.open_api_client.api.users.post_users module

async polarion_rest_api_client.open_api_client.api.users.post_users.asyncio(*, client: AuthenticatedClient | Client, body: UsersListPostRequest) → Errors | UsersListPostResponse | None

Creates a list of Users.

Args:

body (UsersListPostRequest):

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 | UsersListPostResponse

async polarion_rest_api_client.open_api_client.api.users.post_users.asyncio_detailed(*, client: AuthenticatedClient | Client, body: UsersListPostRequest) → Response[Errors | UsersListPostResponse]

Creates a list of Users.

Args:

body (UsersListPostRequest):

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 | UsersListPostResponse]

polarion_rest_api_client.open_api_client.api.users.post_users.sync(*, client: AuthenticatedClient | Client, body: UsersListPostRequest) → Errors | UsersListPostResponse | None

Creates a list of Users.

Args:

body (UsersListPostRequest):

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 | UsersListPostResponse

polarion_rest_api_client.open_api_client.api.users.post_users.sync_detailed(*, client: AuthenticatedClient | Client, body: UsersListPostRequest) → Response[Errors | UsersListPostResponse]

Creates a list of Users.

Args:

body (UsersListPostRequest):

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 | UsersListPostResponse]

polarion_rest_api_client.open_api_client.api.users.set_license module

async polarion_rest_api_client.open_api_client.api.users.set_license.asyncio(user_id: str, *, client: AuthenticatedClient | Client, body: SetLicenseRequestBody) → Any | Errors | None

Sets the User’s license.

Args:

user_id (str): body (SetLicenseRequestBody):

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:

Any | Errors

async polarion_rest_api_client.open_api_client.api.users.set_license.asyncio_detailed(user_id: str, *, client: AuthenticatedClient | Client, body: SetLicenseRequestBody) → Response[Any | Errors]

Sets the User’s license.

Args:

user_id (str): body (SetLicenseRequestBody):

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

polarion_rest_api_client.open_api_client.api.users.set_license.sync(user_id: str, *, client: AuthenticatedClient | Client, body: SetLicenseRequestBody) → Any | Errors | None

Sets the User’s license.

Args:

user_id (str): body (SetLicenseRequestBody):

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:

Any | Errors

polarion_rest_api_client.open_api_client.api.users.set_license.sync_detailed(user_id: str, *, client: AuthenticatedClient | Client, body: SetLicenseRequestBody) → Response[Any | Errors]

Sets the User’s license.

Args:

user_id (str): body (SetLicenseRequestBody):

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

polarion_rest_api_client.open_api_client.api.users.update_avatar module

async polarion_rest_api_client.open_api_client.api.users.update_avatar.asyncio(user_id: str, *, client: AuthenticatedClient | Client, body: UpdateAvatarRequestBody | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Any | Errors | None

Updates the specified User Avatar.

Args:

user_id (str): body (UpdateAvatarRequestBody | 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:

Any | Errors

async polarion_rest_api_client.open_api_client.api.users.update_avatar.asyncio_detailed(user_id: str, *, client: AuthenticatedClient | Client, body: UpdateAvatarRequestBody | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Any | Errors]

Updates the specified User Avatar.

Args:

user_id (str): body (UpdateAvatarRequestBody | 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[Any | Errors]

polarion_rest_api_client.open_api_client.api.users.update_avatar.sync(user_id: str, *, client: AuthenticatedClient | Client, body: UpdateAvatarRequestBody | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Any | Errors | None

Updates the specified User Avatar.

Args:

user_id (str): body (UpdateAvatarRequestBody | 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:

Any | Errors

polarion_rest_api_client.open_api_client.api.users.update_avatar.sync_detailed(user_id: str, *, client: AuthenticatedClient | Client, body: UpdateAvatarRequestBody | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Any | Errors]

Updates the specified User Avatar.

Args:

user_id (str): body (UpdateAvatarRequestBody | 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[Any | Errors]