polarion_rest_api_client.open_api_client.api.document_comments package

Contains endpoint functions for accessing the API

Submodules

polarion_rest_api_client.open_api_client.api.document_comments.get_document_comment module

async polarion_rest_api_client.open_api_client.api.document_comments.get_document_comment.asyncio(project_id: str, space_id: str, document_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>) → DocumentCommentsSingleGetResponse | Errors | None

Returns the specified Document Comment.

Args:

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

DocumentCommentsSingleGetResponse | Errors

async polarion_rest_api_client.open_api_client.api.document_comments.get_document_comment.asyncio_detailed(project_id: str, space_id: str, document_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[DocumentCommentsSingleGetResponse | Errors]

Returns the specified Document Comment.

Args:

project_id (str): space_id (str): document_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[DocumentCommentsSingleGetResponse | Errors]

polarion_rest_api_client.open_api_client.api.document_comments.get_document_comment.sync(project_id: str, space_id: str, document_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>) → DocumentCommentsSingleGetResponse | Errors | None

Returns the specified Document Comment.

Args:

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

DocumentCommentsSingleGetResponse | Errors

polarion_rest_api_client.open_api_client.api.document_comments.get_document_comment.sync_detailed(project_id: str, space_id: str, document_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[DocumentCommentsSingleGetResponse | Errors]

Returns the specified Document Comment.

Args:

project_id (str): space_id (str): document_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[DocumentCommentsSingleGetResponse | Errors]

polarion_rest_api_client.open_api_client.api.document_comments.get_document_comments module

async polarion_rest_api_client.open_api_client.api.document_comments.get_document_comments.asyncio(project_id: str, space_id: str, document_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>) → DocumentCommentsListGetResponse | Errors | None

Returns a list of Document Comments.

Args:

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

DocumentCommentsListGetResponse | Errors

async polarion_rest_api_client.open_api_client.api.document_comments.get_document_comments.asyncio_detailed(project_id: str, space_id: str, document_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[DocumentCommentsListGetResponse | Errors]

Returns a list of Document Comments.

Args:

project_id (str): space_id (str): document_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[DocumentCommentsListGetResponse | Errors]

polarion_rest_api_client.open_api_client.api.document_comments.get_document_comments.sync(project_id: str, space_id: str, document_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>) → DocumentCommentsListGetResponse | Errors | None

Returns a list of Document Comments.

Args:

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

DocumentCommentsListGetResponse | Errors

polarion_rest_api_client.open_api_client.api.document_comments.get_document_comments.sync_detailed(project_id: str, space_id: str, document_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[DocumentCommentsListGetResponse | Errors]

Returns a list of Document Comments.

Args:

project_id (str): space_id (str): document_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[DocumentCommentsListGetResponse | Errors]

polarion_rest_api_client.open_api_client.api.document_comments.patch_document_comment module

async polarion_rest_api_client.open_api_client.api.document_comments.patch_document_comment.asyncio(project_id: str, space_id: str, document_name: str, comment_id: str, *, client: AuthenticatedClient | Client, body: DocumentCommentsSinglePatchRequest) → Any | Errors | None

Updates the specified Document Comment.

Args:

project_id (str): space_id (str): document_name (str): comment_id (str): body (DocumentCommentsSinglePatchRequest):

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.document_comments.patch_document_comment.asyncio_detailed(project_id: str, space_id: str, document_name: str, comment_id: str, *, client: AuthenticatedClient | Client, body: DocumentCommentsSinglePatchRequest) → Response[Any | Errors]

Updates the specified Document Comment.

Args:

project_id (str): space_id (str): document_name (str): comment_id (str): body (DocumentCommentsSinglePatchRequest):

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.document_comments.patch_document_comment.sync(project_id: str, space_id: str, document_name: str, comment_id: str, *, client: AuthenticatedClient | Client, body: DocumentCommentsSinglePatchRequest) → Any | Errors | None

Updates the specified Document Comment.

Args:

project_id (str): space_id (str): document_name (str): comment_id (str): body (DocumentCommentsSinglePatchRequest):

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.document_comments.patch_document_comment.sync_detailed(project_id: str, space_id: str, document_name: str, comment_id: str, *, client: AuthenticatedClient | Client, body: DocumentCommentsSinglePatchRequest) → Response[Any | Errors]

Updates the specified Document Comment.

Args:

project_id (str): space_id (str): document_name (str): comment_id (str): body (DocumentCommentsSinglePatchRequest):

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.document_comments.post_document_comments module

async polarion_rest_api_client.open_api_client.api.document_comments.post_document_comments.asyncio(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: DocumentCommentsListPostRequest) → DocumentCommentsListPostResponse | Errors | None

Creates a list of Document Comments.

Args:

project_id (str): space_id (str): document_name (str): body (DocumentCommentsListPostRequest):

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:

DocumentCommentsListPostResponse | Errors

async polarion_rest_api_client.open_api_client.api.document_comments.post_document_comments.asyncio_detailed(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: DocumentCommentsListPostRequest) → Response[DocumentCommentsListPostResponse | Errors]

Creates a list of Document Comments.

Args:

project_id (str): space_id (str): document_name (str): body (DocumentCommentsListPostRequest):

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

polarion_rest_api_client.open_api_client.api.document_comments.post_document_comments.sync(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: DocumentCommentsListPostRequest) → DocumentCommentsListPostResponse | Errors | None

Creates a list of Document Comments.

Args:

project_id (str): space_id (str): document_name (str): body (DocumentCommentsListPostRequest):

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:

DocumentCommentsListPostResponse | Errors

polarion_rest_api_client.open_api_client.api.document_comments.post_document_comments.sync_detailed(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: DocumentCommentsListPostRequest) → Response[DocumentCommentsListPostResponse | Errors]

Creates a list of Document Comments.

Args:

project_id (str): space_id (str): document_name (str): body (DocumentCommentsListPostRequest):

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