polarion_rest_api_client.open_api_client.api.pages package

Contains endpoint functions for accessing the API.

Submodules

polarion_rest_api_client.open_api_client.api.pages.get_page module

async polarion_rest_api_client.open_api_client.api.pages.get_page.asyncio(project_id: str, space_id: str, page_name: 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 | PagesSingleGetResponse | None

Returns the specified Page.

Args:

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

async polarion_rest_api_client.open_api_client.api.pages.get_page.asyncio_detailed(project_id: str, space_id: str, page_name: 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 | PagesSingleGetResponse]

Returns the specified Page.

Args:

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

polarion_rest_api_client.open_api_client.api.pages.get_page.sync(project_id: str, space_id: str, page_name: 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 | PagesSingleGetResponse | None

Returns the specified Page.

Args:

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

polarion_rest_api_client.open_api_client.api.pages.get_page.sync_detailed(project_id: str, space_id: str, page_name: 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 | PagesSingleGetResponse]

Returns the specified Page.

Args:

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

polarion_rest_api_client.open_api_client.api.pages.patch_rich_page module

async polarion_rest_api_client.open_api_client.api.pages.patch_rich_page.asyncio(project_id: str, space_id: str, page_name: str, *, client: AuthenticatedClient | Client, body: PagesSinglePatchRequest) → Any | Errors | None

Updates the specified Page.

Args:

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

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

Updates the specified Page.

Args:

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

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.pages.patch_rich_page.sync(project_id: str, space_id: str, page_name: str, *, client: AuthenticatedClient | Client, body: PagesSinglePatchRequest) → Any | Errors | None

Updates the specified Page.

Args:

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

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

Updates the specified Page.

Args:

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

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