polarion_rest_api_client.open_api_client.api.enumerations package

Contains endpoint functions for accessing the API.

Submodules

polarion_rest_api_client.open_api_client.api.enumerations.delete_global_enumeration module

async polarion_rest_api_client.open_api_client.api.enumerations.delete_global_enumeration.asyncio(enum_context: str, enum_name: str, target_type: str, *, client: AuthenticatedClient | Client) → Any | Errors | None

Deletes the specified Enumeration from the Global context.

Args:

enum_context (str): enum_name (str): target_type (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[Any, Errors]

async polarion_rest_api_client.open_api_client.api.enumerations.delete_global_enumeration.asyncio_detailed(enum_context: str, enum_name: str, target_type: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]

Deletes the specified Enumeration from the Global context.

Args:

enum_context (str): enum_name (str): target_type (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[Any, Errors]]

polarion_rest_api_client.open_api_client.api.enumerations.delete_global_enumeration.sync(enum_context: str, enum_name: str, target_type: str, *, client: AuthenticatedClient | Client) → Any | Errors | None

Deletes the specified Enumeration from the Global context.

Args:

enum_context (str): enum_name (str): target_type (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[Any, Errors]

polarion_rest_api_client.open_api_client.api.enumerations.delete_global_enumeration.sync_detailed(enum_context: str, enum_name: str, target_type: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]

Deletes the specified Enumeration from the Global context.

Args:

enum_context (str): enum_name (str): target_type (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[Any, Errors]]

polarion_rest_api_client.open_api_client.api.enumerations.delete_project_enumeration module

async polarion_rest_api_client.open_api_client.api.enumerations.delete_project_enumeration.asyncio(project_id: str, enum_context: str, enum_name: str, target_type: str, *, client: AuthenticatedClient | Client) → Any | Errors | None

Deletes the specified Enumeration from the Project context.

Args:

project_id (str): enum_context (str): enum_name (str): target_type (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[Any, Errors]

async polarion_rest_api_client.open_api_client.api.enumerations.delete_project_enumeration.asyncio_detailed(project_id: str, enum_context: str, enum_name: str, target_type: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]

Deletes the specified Enumeration from the Project context.

Args:

project_id (str): enum_context (str): enum_name (str): target_type (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[Any, Errors]]

polarion_rest_api_client.open_api_client.api.enumerations.delete_project_enumeration.sync(project_id: str, enum_context: str, enum_name: str, target_type: str, *, client: AuthenticatedClient | Client) → Any | Errors | None

Deletes the specified Enumeration from the Project context.

Args:

project_id (str): enum_context (str): enum_name (str): target_type (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[Any, Errors]

polarion_rest_api_client.open_api_client.api.enumerations.delete_project_enumeration.sync_detailed(project_id: str, enum_context: str, enum_name: str, target_type: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]

Deletes the specified Enumeration from the Project context.

Args:

project_id (str): enum_context (str): enum_name (str): target_type (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[Any, Errors]]

polarion_rest_api_client.open_api_client.api.enumerations.get_global_enumeration module

async polarion_rest_api_client.open_api_client.api.enumerations.get_global_enumeration.asyncio(enum_context: str, enum_name: str, target_type: 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>) → EnumerationsSingleGetResponse | Errors | None

Returns the specified Enumeration from the Global context.

Args:

enum_context (str): enum_name (str): target_type (str): 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[EnumerationsSingleGetResponse, Errors]

async polarion_rest_api_client.open_api_client.api.enumerations.get_global_enumeration.asyncio_detailed(enum_context: str, enum_name: str, target_type: 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>) → Response[EnumerationsSingleGetResponse | Errors]

Returns the specified Enumeration from the Global context.

Args:

enum_context (str): enum_name (str): target_type (str): 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[EnumerationsSingleGetResponse, Errors]]

polarion_rest_api_client.open_api_client.api.enumerations.get_global_enumeration.sync(enum_context: str, enum_name: str, target_type: 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>) → EnumerationsSingleGetResponse | Errors | None

Returns the specified Enumeration from the Global context.

Args:

enum_context (str): enum_name (str): target_type (str): 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[EnumerationsSingleGetResponse, Errors]

polarion_rest_api_client.open_api_client.api.enumerations.get_global_enumeration.sync_detailed(enum_context: str, enum_name: str, target_type: 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>) → Response[EnumerationsSingleGetResponse | Errors]

Returns the specified Enumeration from the Global context.

Args:

enum_context (str): enum_name (str): target_type (str): 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[EnumerationsSingleGetResponse, Errors]]

polarion_rest_api_client.open_api_client.api.enumerations.get_project_enumeration module

async polarion_rest_api_client.open_api_client.api.enumerations.get_project_enumeration.asyncio(project_id: str, enum_context: str, enum_name: str, target_type: 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>) → EnumerationsSingleGetResponse | Errors | None

Returns the specified Enumeration from the Project context.

Args:

project_id (str): enum_context (str): enum_name (str): target_type (str): 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[EnumerationsSingleGetResponse, Errors]

async polarion_rest_api_client.open_api_client.api.enumerations.get_project_enumeration.asyncio_detailed(project_id: str, enum_context: str, enum_name: str, target_type: 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>) → Response[EnumerationsSingleGetResponse | Errors]

Returns the specified Enumeration from the Project context.

Args:

project_id (str): enum_context (str): enum_name (str): target_type (str): 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[EnumerationsSingleGetResponse, Errors]]

polarion_rest_api_client.open_api_client.api.enumerations.get_project_enumeration.sync(project_id: str, enum_context: str, enum_name: str, target_type: 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>) → EnumerationsSingleGetResponse | Errors | None

Returns the specified Enumeration from the Project context.

Args:

project_id (str): enum_context (str): enum_name (str): target_type (str): 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[EnumerationsSingleGetResponse, Errors]

polarion_rest_api_client.open_api_client.api.enumerations.get_project_enumeration.sync_detailed(project_id: str, enum_context: str, enum_name: str, target_type: 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>) → Response[EnumerationsSingleGetResponse | Errors]

Returns the specified Enumeration from the Project context.

Args:

project_id (str): enum_context (str): enum_name (str): target_type (str): 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[EnumerationsSingleGetResponse, Errors]]

polarion_rest_api_client.open_api_client.api.enumerations.patch_global_enumeration module

async polarion_rest_api_client.open_api_client.api.enumerations.patch_global_enumeration.asyncio(enum_context: str, enum_name: str, target_type: str, *, client: AuthenticatedClient | Client, body: EnumerationsSinglePatchRequest) → Any | Errors | None

Updates the specified Enumeration in the Global context.

Args:

enum_context (str): enum_name (str): target_type (str): body (EnumerationsSinglePatchRequest):

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.enumerations.patch_global_enumeration.asyncio_detailed(enum_context: str, enum_name: str, target_type: str, *, client: AuthenticatedClient | Client, body: EnumerationsSinglePatchRequest) → Response[Any | Errors]

Updates the specified Enumeration in the Global context.

Args:

enum_context (str): enum_name (str): target_type (str): body (EnumerationsSinglePatchRequest):

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.enumerations.patch_global_enumeration.sync(enum_context: str, enum_name: str, target_type: str, *, client: AuthenticatedClient | Client, body: EnumerationsSinglePatchRequest) → Any | Errors | None

Updates the specified Enumeration in the Global context.

Args:

enum_context (str): enum_name (str): target_type (str): body (EnumerationsSinglePatchRequest):

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.enumerations.patch_global_enumeration.sync_detailed(enum_context: str, enum_name: str, target_type: str, *, client: AuthenticatedClient | Client, body: EnumerationsSinglePatchRequest) → Response[Any | Errors]

Updates the specified Enumeration in the Global context.

Args:

enum_context (str): enum_name (str): target_type (str): body (EnumerationsSinglePatchRequest):

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.enumerations.patch_project_enumeration module

async polarion_rest_api_client.open_api_client.api.enumerations.patch_project_enumeration.asyncio(project_id: str, enum_context: str, enum_name: str, target_type: str, *, client: AuthenticatedClient | Client, body: EnumerationsSinglePatchRequest) → Any | Errors | None

Updates the specified Enumeration in the Project context.

Args:

project_id (str): enum_context (str): enum_name (str): target_type (str): body (EnumerationsSinglePatchRequest):

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.enumerations.patch_project_enumeration.asyncio_detailed(project_id: str, enum_context: str, enum_name: str, target_type: str, *, client: AuthenticatedClient | Client, body: EnumerationsSinglePatchRequest) → Response[Any | Errors]

Updates the specified Enumeration in the Project context.

Args:

project_id (str): enum_context (str): enum_name (str): target_type (str): body (EnumerationsSinglePatchRequest):

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.enumerations.patch_project_enumeration.sync(project_id: str, enum_context: str, enum_name: str, target_type: str, *, client: AuthenticatedClient | Client, body: EnumerationsSinglePatchRequest) → Any | Errors | None

Updates the specified Enumeration in the Project context.

Args:

project_id (str): enum_context (str): enum_name (str): target_type (str): body (EnumerationsSinglePatchRequest):

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.enumerations.patch_project_enumeration.sync_detailed(project_id: str, enum_context: str, enum_name: str, target_type: str, *, client: AuthenticatedClient | Client, body: EnumerationsSinglePatchRequest) → Response[Any | Errors]

Updates the specified Enumeration in the Project context.

Args:

project_id (str): enum_context (str): enum_name (str): target_type (str): body (EnumerationsSinglePatchRequest):

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.enumerations.post_global_enumeration module

async polarion_rest_api_client.open_api_client.api.enumerations.post_global_enumeration.asyncio(*, client: AuthenticatedClient | Client, body: EnumerationsListPostRequest) → EnumerationsListPostResponse | Errors | None

Creates a list of Enumerations in the Global context.

Args:

body (EnumerationsListPostRequest):

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[EnumerationsListPostResponse, Errors]

async polarion_rest_api_client.open_api_client.api.enumerations.post_global_enumeration.asyncio_detailed(*, client: AuthenticatedClient | Client, body: EnumerationsListPostRequest) → Response[EnumerationsListPostResponse | Errors]

Creates a list of Enumerations in the Global context.

Args:

body (EnumerationsListPostRequest):

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[EnumerationsListPostResponse, Errors]]

polarion_rest_api_client.open_api_client.api.enumerations.post_global_enumeration.sync(*, client: AuthenticatedClient | Client, body: EnumerationsListPostRequest) → EnumerationsListPostResponse | Errors | None

Creates a list of Enumerations in the Global context.

Args:

body (EnumerationsListPostRequest):

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[EnumerationsListPostResponse, Errors]

polarion_rest_api_client.open_api_client.api.enumerations.post_global_enumeration.sync_detailed(*, client: AuthenticatedClient | Client, body: EnumerationsListPostRequest) → Response[EnumerationsListPostResponse | Errors]

Creates a list of Enumerations in the Global context.

Args:

body (EnumerationsListPostRequest):

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[EnumerationsListPostResponse, Errors]]

polarion_rest_api_client.open_api_client.api.enumerations.post_project_enumeration module

async polarion_rest_api_client.open_api_client.api.enumerations.post_project_enumeration.asyncio(project_id: str, *, client: AuthenticatedClient | Client, body: EnumerationsListPostRequest) → EnumerationsListPostResponse | Errors | None

Creates a list of Enumerations in the Project context.

Args:

project_id (str): body (EnumerationsListPostRequest):

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[EnumerationsListPostResponse, Errors]

async polarion_rest_api_client.open_api_client.api.enumerations.post_project_enumeration.asyncio_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: EnumerationsListPostRequest) → Response[EnumerationsListPostResponse | Errors]

Creates a list of Enumerations in the Project context.

Args:

project_id (str): body (EnumerationsListPostRequest):

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[EnumerationsListPostResponse, Errors]]

polarion_rest_api_client.open_api_client.api.enumerations.post_project_enumeration.sync(project_id: str, *, client: AuthenticatedClient | Client, body: EnumerationsListPostRequest) → EnumerationsListPostResponse | Errors | None

Creates a list of Enumerations in the Project context.

Args:

project_id (str): body (EnumerationsListPostRequest):

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[EnumerationsListPostResponse, Errors]

polarion_rest_api_client.open_api_client.api.enumerations.post_project_enumeration.sync_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: EnumerationsListPostRequest) → Response[EnumerationsListPostResponse | Errors]

Creates a list of Enumerations in the Project context.

Args:

project_id (str): body (EnumerationsListPostRequest):

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[EnumerationsListPostResponse, Errors]]