polarion_rest_api_client.open_api_client.api.work_item_approvals package

Contains endpoint functions for accessing the API.

Submodules

polarion_rest_api_client.open_api_client.api.work_item_approvals.delete_approval module

async polarion_rest_api_client.open_api_client.api.work_item_approvals.delete_approval.asyncio(project_id: str, work_item_id: str, user_id: str, *, client: AuthenticatedClient | Client) Any | Errors | None

Deletes the specified Work Item Approval.

Args:

project_id (str): work_item_id (str): 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:

Union[Any, Errors]

async polarion_rest_api_client.open_api_client.api.work_item_approvals.delete_approval.asyncio_detailed(project_id: str, work_item_id: str, user_id: str, *, client: AuthenticatedClient | Client) Response[Any | Errors]

Deletes the specified Work Item Approval.

Args:

project_id (str): work_item_id (str): 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[Union[Any, Errors]]

polarion_rest_api_client.open_api_client.api.work_item_approvals.delete_approval.sync(project_id: str, work_item_id: str, user_id: str, *, client: AuthenticatedClient | Client) Any | Errors | None

Deletes the specified Work Item Approval.

Args:

project_id (str): work_item_id (str): 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:

Union[Any, Errors]

polarion_rest_api_client.open_api_client.api.work_item_approvals.delete_approval.sync_detailed(project_id: str, work_item_id: str, user_id: str, *, client: AuthenticatedClient | Client) Response[Any | Errors]

Deletes the specified Work Item Approval.

Args:

project_id (str): work_item_id (str): 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[Union[Any, Errors]]

polarion_rest_api_client.open_api_client.api.work_item_approvals.delete_approvals module

async polarion_rest_api_client.open_api_client.api.work_item_approvals.delete_approvals.asyncio(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: WorkitemApprovalsListDeleteRequest) Any | Errors | None

Deletes a list of Work Item Approvals.

Args:

project_id (str): work_item_id (str): body (WorkitemApprovalsListDeleteRequest):

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

async polarion_rest_api_client.open_api_client.api.work_item_approvals.delete_approvals.asyncio_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: WorkitemApprovalsListDeleteRequest) Response[Any | Errors]

Deletes a list of Work Item Approvals.

Args:

project_id (str): work_item_id (str): body (WorkitemApprovalsListDeleteRequest):

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

polarion_rest_api_client.open_api_client.api.work_item_approvals.delete_approvals.sync(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: WorkitemApprovalsListDeleteRequest) Any | Errors | None

Deletes a list of Work Item Approvals.

Args:

project_id (str): work_item_id (str): body (WorkitemApprovalsListDeleteRequest):

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

polarion_rest_api_client.open_api_client.api.work_item_approvals.delete_approvals.sync_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: WorkitemApprovalsListDeleteRequest) Response[Any | Errors]

Deletes a list of Work Item Approvals.

Args:

project_id (str): work_item_id (str): body (WorkitemApprovalsListDeleteRequest):

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

polarion_rest_api_client.open_api_client.api.work_item_approvals.get_work_item_approval module

async polarion_rest_api_client.open_api_client.api.work_item_approvals.get_work_item_approval.asyncio(project_id: str, work_item_id: str, user_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) Errors | WorkitemApprovalsSingleGetResponse | None

Returns the specified instance.

Args:

project_id (str): work_item_id (str): user_id (str): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): revision (Union[Unset, 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[Errors, WorkitemApprovalsSingleGetResponse]

async polarion_rest_api_client.open_api_client.api.work_item_approvals.get_work_item_approval.asyncio_detailed(project_id: str, work_item_id: str, user_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) Response[Errors | WorkitemApprovalsSingleGetResponse]

Returns the specified instance.

Args:

project_id (str): work_item_id (str): user_id (str): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): revision (Union[Unset, 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[Errors, WorkitemApprovalsSingleGetResponse]]

polarion_rest_api_client.open_api_client.api.work_item_approvals.get_work_item_approval.sync(project_id: str, work_item_id: str, user_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) Errors | WorkitemApprovalsSingleGetResponse | None

Returns the specified instance.

Args:

project_id (str): work_item_id (str): user_id (str): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): revision (Union[Unset, 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[Errors, WorkitemApprovalsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.work_item_approvals.get_work_item_approval.sync_detailed(project_id: str, work_item_id: str, user_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) Response[Errors | WorkitemApprovalsSingleGetResponse]

Returns the specified instance.

Args:

project_id (str): work_item_id (str): user_id (str): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): revision (Union[Unset, 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[Errors, WorkitemApprovalsSingleGetResponse]]

polarion_rest_api_client.open_api_client.api.work_item_approvals.get_work_item_approvals module

async polarion_rest_api_client.open_api_client.api.work_item_approvals.get_work_item_approvals.asyncio(project_id: str, work_item_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, pagesize: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) Errors | WorkitemApprovalsListGetResponse | None

Returns a list of instances.

Args:

project_id (str): work_item_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): revision (Union[Unset, 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[Errors, WorkitemApprovalsListGetResponse]

async polarion_rest_api_client.open_api_client.api.work_item_approvals.get_work_item_approvals.asyncio_detailed(project_id: str, work_item_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, pagesize: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) Response[Errors | WorkitemApprovalsListGetResponse]

Returns a list of instances.

Args:

project_id (str): work_item_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): revision (Union[Unset, 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[Errors, WorkitemApprovalsListGetResponse]]

polarion_rest_api_client.open_api_client.api.work_item_approvals.get_work_item_approvals.sync(project_id: str, work_item_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, pagesize: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) Errors | WorkitemApprovalsListGetResponse | None

Returns a list of instances.

Args:

project_id (str): work_item_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): revision (Union[Unset, 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[Errors, WorkitemApprovalsListGetResponse]

polarion_rest_api_client.open_api_client.api.work_item_approvals.get_work_item_approvals.sync_detailed(project_id: str, work_item_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, pagesize: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) Response[Errors | WorkitemApprovalsListGetResponse]

Returns a list of instances.

Args:

project_id (str): work_item_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): revision (Union[Unset, 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[Errors, WorkitemApprovalsListGetResponse]]

polarion_rest_api_client.open_api_client.api.work_item_approvals.patch_work_item_approval module

async polarion_rest_api_client.open_api_client.api.work_item_approvals.patch_work_item_approval.asyncio(project_id: str, work_item_id: str, user_id: str, *, client: AuthenticatedClient | Client, body: WorkitemApprovalsSinglePatchRequest) Any | Errors | None

Updates the specified instance.

Args:

project_id (str): work_item_id (str): user_id (str): body (WorkitemApprovalsSinglePatchRequest):

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

async polarion_rest_api_client.open_api_client.api.work_item_approvals.patch_work_item_approval.asyncio_detailed(project_id: str, work_item_id: str, user_id: str, *, client: AuthenticatedClient | Client, body: WorkitemApprovalsSinglePatchRequest) Response[Any | Errors]

Updates the specified instance.

Args:

project_id (str): work_item_id (str): user_id (str): body (WorkitemApprovalsSinglePatchRequest):

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

polarion_rest_api_client.open_api_client.api.work_item_approvals.patch_work_item_approval.sync(project_id: str, work_item_id: str, user_id: str, *, client: AuthenticatedClient | Client, body: WorkitemApprovalsSinglePatchRequest) Any | Errors | None

Updates the specified instance.

Args:

project_id (str): work_item_id (str): user_id (str): body (WorkitemApprovalsSinglePatchRequest):

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

polarion_rest_api_client.open_api_client.api.work_item_approvals.patch_work_item_approval.sync_detailed(project_id: str, work_item_id: str, user_id: str, *, client: AuthenticatedClient | Client, body: WorkitemApprovalsSinglePatchRequest) Response[Any | Errors]

Updates the specified instance.

Args:

project_id (str): work_item_id (str): user_id (str): body (WorkitemApprovalsSinglePatchRequest):

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

polarion_rest_api_client.open_api_client.api.work_item_approvals.patch_work_item_approvals module

async polarion_rest_api_client.open_api_client.api.work_item_approvals.patch_work_item_approvals.asyncio(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: WorkitemApprovalsListPatchRequest) Any | Errors | None

Updates a list of instances.

Args:

project_id (str): work_item_id (str): body (WorkitemApprovalsListPatchRequest):

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

async polarion_rest_api_client.open_api_client.api.work_item_approvals.patch_work_item_approvals.asyncio_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: WorkitemApprovalsListPatchRequest) Response[Any | Errors]

Updates a list of instances.

Args:

project_id (str): work_item_id (str): body (WorkitemApprovalsListPatchRequest):

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

polarion_rest_api_client.open_api_client.api.work_item_approvals.patch_work_item_approvals.sync(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: WorkitemApprovalsListPatchRequest) Any | Errors | None

Updates a list of instances.

Args:

project_id (str): work_item_id (str): body (WorkitemApprovalsListPatchRequest):

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

polarion_rest_api_client.open_api_client.api.work_item_approvals.patch_work_item_approvals.sync_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: WorkitemApprovalsListPatchRequest) Response[Any | Errors]

Updates a list of instances.

Args:

project_id (str): work_item_id (str): body (WorkitemApprovalsListPatchRequest):

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

polarion_rest_api_client.open_api_client.api.work_item_approvals.post_work_item_approvals module

async polarion_rest_api_client.open_api_client.api.work_item_approvals.post_work_item_approvals.asyncio(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: WorkitemApprovalsListPostRequest) Errors | WorkitemApprovalsListPostResponse | None

Creates a list of WorkItem Approvals.

Args:

project_id (str): work_item_id (str): body (WorkitemApprovalsListPostRequest):

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[Errors, WorkitemApprovalsListPostResponse]

async polarion_rest_api_client.open_api_client.api.work_item_approvals.post_work_item_approvals.asyncio_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: WorkitemApprovalsListPostRequest) Response[Errors | WorkitemApprovalsListPostResponse]

Creates a list of WorkItem Approvals.

Args:

project_id (str): work_item_id (str): body (WorkitemApprovalsListPostRequest):

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[Errors, WorkitemApprovalsListPostResponse]]

polarion_rest_api_client.open_api_client.api.work_item_approvals.post_work_item_approvals.sync(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: WorkitemApprovalsListPostRequest) Errors | WorkitemApprovalsListPostResponse | None

Creates a list of WorkItem Approvals.

Args:

project_id (str): work_item_id (str): body (WorkitemApprovalsListPostRequest):

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[Errors, WorkitemApprovalsListPostResponse]

polarion_rest_api_client.open_api_client.api.work_item_approvals.post_work_item_approvals.sync_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: WorkitemApprovalsListPostRequest) Response[Errors | WorkitemApprovalsListPostResponse]

Creates a list of WorkItem Approvals.

Args:

project_id (str): work_item_id (str): body (WorkitemApprovalsListPostRequest):

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[Errors, WorkitemApprovalsListPostResponse]]