polarion_rest_api_client.open_api_client.api.page_comments package

Contains endpoint functions for accessing the API

Submodules

polarion_rest_api_client.open_api_client.api.page_comments.get_page_comment module

async polarion_rest_api_client.open_api_client.api.page_comments.get_page_comment.asyncio(project_id: str, space_id: str, page_name: str, comment_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 | PageCommentsSingleGetResponse | None

Returns the specified Page Comment.

Args:

project_id (str): space_id (str): page_name (str): comment_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 | PageCommentsSingleGetResponse

async polarion_rest_api_client.open_api_client.api.page_comments.get_page_comment.asyncio_detailed(project_id: str, space_id: str, page_name: str, comment_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 | PageCommentsSingleGetResponse]

Returns the specified Page Comment.

Args:

project_id (str): space_id (str): page_name (str): comment_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 | PageCommentsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.page_comments.get_page_comment.sync(project_id: str, space_id: str, page_name: str, comment_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 | PageCommentsSingleGetResponse | None

Returns the specified Page Comment.

Args:

project_id (str): space_id (str): page_name (str): comment_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 | PageCommentsSingleGetResponse

polarion_rest_api_client.open_api_client.api.page_comments.get_page_comment.sync_detailed(project_id: str, space_id: str, page_name: str, comment_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 | PageCommentsSingleGetResponse]

Returns the specified Page Comment.

Args:

project_id (str): space_id (str): page_name (str): comment_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 | PageCommentsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.page_comments.get_page_comments module

async polarion_rest_api_client.open_api_client.api.page_comments.get_page_comments.asyncio(project_id: str, space_id: str, page_name: 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 | PageCommentsListGetResponse | None

Returns a list of Page Comments.

Args:

project_id (str): space_id (str): page_name (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 | PageCommentsListGetResponse

async polarion_rest_api_client.open_api_client.api.page_comments.get_page_comments.asyncio_detailed(project_id: str, space_id: str, page_name: 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 | PageCommentsListGetResponse]

Returns a list of Page Comments.

Args:

project_id (str): space_id (str): page_name (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 | PageCommentsListGetResponse]

polarion_rest_api_client.open_api_client.api.page_comments.get_page_comments.sync(project_id: str, space_id: str, page_name: 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 | PageCommentsListGetResponse | None

Returns a list of Page Comments.

Args:

project_id (str): space_id (str): page_name (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 | PageCommentsListGetResponse

polarion_rest_api_client.open_api_client.api.page_comments.get_page_comments.sync_detailed(project_id: str, space_id: str, page_name: 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 | PageCommentsListGetResponse]

Returns a list of Page Comments.

Args:

project_id (str): space_id (str): page_name (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 | PageCommentsListGetResponse]

polarion_rest_api_client.open_api_client.api.page_comments.patch_page_comment module

async polarion_rest_api_client.open_api_client.api.page_comments.patch_page_comment.asyncio(project_id: str, space_id: str, page_name: str, comment_id: str, *, client: AuthenticatedClient | Client, body: PageCommentsSinglePatchRequest) → Any | Errors | None

Updates the specified Page Comment.

Args:

project_id (str): space_id (str): page_name (str): comment_id (str): body (PageCommentsSinglePatchRequest):

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.page_comments.patch_page_comment.asyncio_detailed(project_id: str, space_id: str, page_name: str, comment_id: str, *, client: AuthenticatedClient | Client, body: PageCommentsSinglePatchRequest) → Response[Any | Errors]

Updates the specified Page Comment.

Args:

project_id (str): space_id (str): page_name (str): comment_id (str): body (PageCommentsSinglePatchRequest):

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.page_comments.patch_page_comment.sync(project_id: str, space_id: str, page_name: str, comment_id: str, *, client: AuthenticatedClient | Client, body: PageCommentsSinglePatchRequest) → Any | Errors | None

Updates the specified Page Comment.

Args:

project_id (str): space_id (str): page_name (str): comment_id (str): body (PageCommentsSinglePatchRequest):

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.page_comments.patch_page_comment.sync_detailed(project_id: str, space_id: str, page_name: str, comment_id: str, *, client: AuthenticatedClient | Client, body: PageCommentsSinglePatchRequest) → Response[Any | Errors]

Updates the specified Page Comment.

Args:

project_id (str): space_id (str): page_name (str): comment_id (str): body (PageCommentsSinglePatchRequest):

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.page_comments.post_page_comments module

async polarion_rest_api_client.open_api_client.api.page_comments.post_page_comments.asyncio(project_id: str, space_id: str, page_name: str, *, client: AuthenticatedClient | Client, body: PageCommentsListPostRequest) → Errors | PageCommentsListPostResponse | None

Creates a list of Page Comments.

Args:

project_id (str): space_id (str): page_name (str): body (PageCommentsListPostRequest):

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

async polarion_rest_api_client.open_api_client.api.page_comments.post_page_comments.asyncio_detailed(project_id: str, space_id: str, page_name: str, *, client: AuthenticatedClient | Client, body: PageCommentsListPostRequest) → Response[Errors | PageCommentsListPostResponse]

Creates a list of Page Comments.

Args:

project_id (str): space_id (str): page_name (str): body (PageCommentsListPostRequest):

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

polarion_rest_api_client.open_api_client.api.page_comments.post_page_comments.sync(project_id: str, space_id: str, page_name: str, *, client: AuthenticatedClient | Client, body: PageCommentsListPostRequest) → Errors | PageCommentsListPostResponse | None

Creates a list of Page Comments.

Args:

project_id (str): space_id (str): page_name (str): body (PageCommentsListPostRequest):

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

polarion_rest_api_client.open_api_client.api.page_comments.post_page_comments.sync_detailed(project_id: str, space_id: str, page_name: str, *, client: AuthenticatedClient | Client, body: PageCommentsListPostRequest) → Response[Errors | PageCommentsListPostResponse]

Creates a list of Page Comments.

Args:

project_id (str): space_id (str): page_name (str): body (PageCommentsListPostRequest):

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