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:

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

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

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

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[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: 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 | WorkitemApprovalsSingleGetResponse | None

Returns the specified instance.

Args:

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

Returns the specified instance.

Args:

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

Returns the specified instance.

Args:

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

Returns the specified instance.

Args:

project_id (str): work_item_id (str): 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 | 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: 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>, revision: str | Unset = <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 (int | Unset): pagenumber (int | Unset): 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 | 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: 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>, revision: str | Unset = <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 (int | Unset): pagenumber (int | Unset): 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 | 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: 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>, revision: str | Unset = <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 (int | Unset): pagenumber (int | Unset): 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 | 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: 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>, revision: str | Unset = <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 (int | Unset): pagenumber (int | Unset): 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 | 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:

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

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

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

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

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

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