polarion_rest_api_client.open_api_client.api.project_templates package

Contains endpoint functions for accessing the API.

Submodules

polarion_rest_api_client.open_api_client.api.project_templates.get_project_templates module

async polarion_rest_api_client.open_api_client.api.project_templates.get_project_templates.asyncio(*, 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>) → Errors | ProjecttemplatesListGetResponse | None

Returns a list of Project Templates.

Args:

pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (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, ProjecttemplatesListGetResponse]

async polarion_rest_api_client.open_api_client.api.project_templates.get_project_templates.asyncio_detailed(*, 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>) → Response[Errors | ProjecttemplatesListGetResponse]

Returns a list of Project Templates.

Args:

pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (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, ProjecttemplatesListGetResponse]]

polarion_rest_api_client.open_api_client.api.project_templates.get_project_templates.sync(*, 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>) → Errors | ProjecttemplatesListGetResponse | None

Returns a list of Project Templates.

Args:

pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (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, ProjecttemplatesListGetResponse]

polarion_rest_api_client.open_api_client.api.project_templates.get_project_templates.sync_detailed(*, 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>) → Response[Errors | ProjecttemplatesListGetResponse]

Returns a list of Project Templates.

Args:

pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (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, ProjecttemplatesListGetResponse]]