polarion_rest_api_client.open_api_client.api.icons package¶

Contains endpoint functions for accessing the API

Submodules¶

polarion_rest_api_client.open_api_client.api.icons.get_default_icon module¶

async polarion_rest_api_client.open_api_client.api.icons.get_default_icon.asyncio(icon_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | IconsSingleGetResponse | None¶

Returns the specified Icon from the default context.

Args:: icon_id (str): fields (SparseFields | 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 | IconsSingleGetResponse

async polarion_rest_api_client.open_api_client.api.icons.get_default_icon.asyncio_detailed(icon_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | IconsSingleGetResponse]¶

Returns the specified Icon from the default context.

Args:: icon_id (str): fields (SparseFields | 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 | IconsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.icons.get_default_icon.sync(icon_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | IconsSingleGetResponse | None¶

Returns the specified Icon from the default context.

Args:: icon_id (str): fields (SparseFields | 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 | IconsSingleGetResponse

polarion_rest_api_client.open_api_client.api.icons.get_default_icon.sync_detailed(icon_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | IconsSingleGetResponse]¶

Returns the specified Icon from the default context.

Args:: icon_id (str): fields (SparseFields | 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 | IconsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.icons.get_default_icons module¶

async polarion_rest_api_client.open_api_client.api.icons.get_default_icons.asyncio(*, 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>) → Errors | IconsListGetResponse | None¶

Returns a list of Icons from the default context.

Args:: pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | 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 | IconsListGetResponse

async polarion_rest_api_client.open_api_client.api.icons.get_default_icons.asyncio_detailed(*, 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>) → Response[Errors | IconsListGetResponse]¶

Returns a list of Icons from the default context.

Args:: pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | 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 | IconsListGetResponse]

polarion_rest_api_client.open_api_client.api.icons.get_default_icons.sync(*, 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>) → Errors | IconsListGetResponse | None¶

Returns a list of Icons from the default context.

Args:: pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | 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 | IconsListGetResponse

polarion_rest_api_client.open_api_client.api.icons.get_default_icons.sync_detailed(*, 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>) → Response[Errors | IconsListGetResponse]¶

Returns a list of Icons from the default context.

Args:: pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | 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 | IconsListGetResponse]

polarion_rest_api_client.open_api_client.api.icons.get_global_icon module¶

async polarion_rest_api_client.open_api_client.api.icons.get_global_icon.asyncio(icon_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | IconsSingleGetResponse | None¶

Returns the specified Icon from the Global context.

Args:: icon_id (str): fields (SparseFields | 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 | IconsSingleGetResponse

async polarion_rest_api_client.open_api_client.api.icons.get_global_icon.asyncio_detailed(icon_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | IconsSingleGetResponse]¶

Returns the specified Icon from the Global context.

Args:: icon_id (str): fields (SparseFields | 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 | IconsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.icons.get_global_icon.sync(icon_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | IconsSingleGetResponse | None¶

Returns the specified Icon from the Global context.

Args:: icon_id (str): fields (SparseFields | 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 | IconsSingleGetResponse

polarion_rest_api_client.open_api_client.api.icons.get_global_icon.sync_detailed(icon_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | IconsSingleGetResponse]¶

Returns the specified Icon from the Global context.

Args:: icon_id (str): fields (SparseFields | 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 | IconsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.icons.get_global_icons module¶

async polarion_rest_api_client.open_api_client.api.icons.get_global_icons.asyncio(*, 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>) → Errors | IconsListGetResponse | None¶

Returns a list of Icons from the Global context.

Args:: pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | 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 | IconsListGetResponse

async polarion_rest_api_client.open_api_client.api.icons.get_global_icons.asyncio_detailed(*, 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>) → Response[Errors | IconsListGetResponse]¶

Returns a list of Icons from the Global context.

Args:: pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | 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 | IconsListGetResponse]

polarion_rest_api_client.open_api_client.api.icons.get_global_icons.sync(*, 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>) → Errors | IconsListGetResponse | None¶

Returns a list of Icons from the Global context.

Args:: pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | 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 | IconsListGetResponse

polarion_rest_api_client.open_api_client.api.icons.get_global_icons.sync_detailed(*, 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>) → Response[Errors | IconsListGetResponse]¶

Returns a list of Icons from the Global context.

Args:: pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | 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 | IconsListGetResponse]

polarion_rest_api_client.open_api_client.api.icons.get_project_icon module¶

async polarion_rest_api_client.open_api_client.api.icons.get_project_icon.asyncio(project_id: str, icon_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | IconsSingleGetResponse | None¶

Returns the specified Icon from the Project context.

Args:: project_id (str): icon_id (str): fields (SparseFields | 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 | IconsSingleGetResponse

async polarion_rest_api_client.open_api_client.api.icons.get_project_icon.asyncio_detailed(project_id: str, icon_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | IconsSingleGetResponse]¶

Returns the specified Icon from the Project context.

Args:: project_id (str): icon_id (str): fields (SparseFields | 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 | IconsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.icons.get_project_icon.sync(project_id: str, icon_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | IconsSingleGetResponse | None¶

Returns the specified Icon from the Project context.

Args:: project_id (str): icon_id (str): fields (SparseFields | 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 | IconsSingleGetResponse

polarion_rest_api_client.open_api_client.api.icons.get_project_icon.sync_detailed(project_id: str, icon_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | IconsSingleGetResponse]¶

Returns the specified Icon from the Project context.

Args:: project_id (str): icon_id (str): fields (SparseFields | 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 | IconsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.icons.get_project_icons module¶

async polarion_rest_api_client.open_api_client.api.icons.get_project_icons.asyncio(project_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>) → Errors | IconsListGetResponse | None¶

Returns a list of Icons from the Project context.

Args:: project_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | 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 | IconsListGetResponse

async polarion_rest_api_client.open_api_client.api.icons.get_project_icons.asyncio_detailed(project_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>) → Response[Errors | IconsListGetResponse]¶

Returns a list of Icons from the Project context.

Args:: project_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | 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 | IconsListGetResponse]

polarion_rest_api_client.open_api_client.api.icons.get_project_icons.sync(project_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>) → Errors | IconsListGetResponse | None¶

Returns a list of Icons from the Project context.

Args:: project_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | 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 | IconsListGetResponse

polarion_rest_api_client.open_api_client.api.icons.get_project_icons.sync_detailed(project_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>) → Response[Errors | IconsListGetResponse]¶

Returns a list of Icons from the Project context.

Args:: project_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | 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 | IconsListGetResponse]

polarion_rest_api_client.open_api_client.api.icons.post_global_icons module¶

async polarion_rest_api_client.open_api_client.api.icons.post_global_icons.asyncio(*, client: AuthenticatedClient | Client, body: PostIconsRequestBody) → Errors | IconsListPostResponse | None¶

Creates a list of Icons in the Global context.

Icons are identified by order

Args:: body (PostIconsRequestBody):
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 | IconsListPostResponse

async polarion_rest_api_client.open_api_client.api.icons.post_global_icons.asyncio_detailed(*, client: AuthenticatedClient | Client, body: PostIconsRequestBody) → Response[Errors | IconsListPostResponse]¶

Creates a list of Icons in the Global context.

Icons are identified by order

Args:: body (PostIconsRequestBody):
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 | IconsListPostResponse]

polarion_rest_api_client.open_api_client.api.icons.post_global_icons.sync(*, client: AuthenticatedClient | Client, body: PostIconsRequestBody) → Errors | IconsListPostResponse | None¶

Creates a list of Icons in the Global context.

Icons are identified by order

Args:: body (PostIconsRequestBody):
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 | IconsListPostResponse

polarion_rest_api_client.open_api_client.api.icons.post_global_icons.sync_detailed(*, client: AuthenticatedClient | Client, body: PostIconsRequestBody) → Response[Errors | IconsListPostResponse]¶

Creates a list of Icons in the Global context.

Icons are identified by order

Args:: body (PostIconsRequestBody):
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 | IconsListPostResponse]

polarion_rest_api_client.open_api_client.api.icons.post_project_icons module¶

async polarion_rest_api_client.open_api_client.api.icons.post_project_icons.asyncio(project_id: str, *, client: AuthenticatedClient | Client, body: PostIconsRequestBody) → Errors | IconsListPostResponse | None¶

Creates a list of Icons in the Project context.

Icons are identified by order

Args:: project_id (str): body (PostIconsRequestBody):
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 | IconsListPostResponse

async polarion_rest_api_client.open_api_client.api.icons.post_project_icons.asyncio_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: PostIconsRequestBody) → Response[Errors | IconsListPostResponse]¶

Creates a list of Icons in the Project context.

Icons are identified by order

Args:: project_id (str): body (PostIconsRequestBody):
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 | IconsListPostResponse]

polarion_rest_api_client.open_api_client.api.icons.post_project_icons.sync(project_id: str, *, client: AuthenticatedClient | Client, body: PostIconsRequestBody) → Errors | IconsListPostResponse | None¶

Creates a list of Icons in the Project context.

Icons are identified by order

Args:: project_id (str): body (PostIconsRequestBody):
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 | IconsListPostResponse

polarion_rest_api_client.open_api_client.api.icons.post_project_icons.sync_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: PostIconsRequestBody) → Response[Errors | IconsListPostResponse]¶

Creates a list of Icons in the Project context.

Icons are identified by order

Args:: project_id (str): body (PostIconsRequestBody):
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 | IconsListPostResponse]